Diff: main.h

Revision:

8:ffcde84b8cf3

Parent:

7:962b5f044a9b

Child:

9:163159830eaf

--- a/main.h	Sun Apr 12 22:08:16 2015 +0000
+++ b/main.h	Thu Apr 30 17:12:41 2015 +0000
@@ -1,7 +1,7 @@
 /**
 @file main.h
 @brief Header file containng function prototypes, defines and global variables.
-@brief Shows a Ultra-sonic Distance Sensor
+@brief Ultra-sonic Distance Sensor
 @author Jakobi Blackburn
 @date 13 March 2015
 */
@@ -18,7 +18,7 @@
 #include "N5110.h"
 #include "SRF02/SRF02.h"
 
-// Inputs
+// --- Inputs ---
 /**
 @namespace UnitTog
 @brief An Interrupt button that toggles the Unit
@@ -51,7 +51,7 @@
 */
 SRF02 sensor(p28,p27);//SDA SCL
 
-// Outputs
+// --- Outputs ---
 /**
 @namespace N5110 LCD
 @brief An LCD screen that requires
@@ -60,7 +60,8 @@
 N5110 lcd(p7,p8,p9,p10,p11,p13,p26);
 /**
 @namespace Buzzer
-@brief A buzzer that can produce different notes dependant on the frquency of the signal inputted to it. Used as an
+@brief A buzzer that can produce different notes dependant on the frquency of 
+@brief the signal inputted to it. Used as an auditory alert
 */  
 Speaker Buzzer(p18);
 /**
@@ -118,6 +119,9 @@
 
 //  ---- functions ----
 
+/**
+Contains the main code
+*/
 void theMain();
 /**
 deals with the visual and audiable alerts.
@@ -181,10 +185,6 @@
 */
 void introTune();
 /**
-sets every other pixel on, creating a checkerboard like effect
-*/
-void checkerBoard();
-/**
 sets the parameters for the first visual mode
 */
 void LCDVis0();
@@ -250,10 +250,6 @@
 }; 
 int Vstate=0;/*!< sets the initial state */
 
-
-
-
-
 #endif