improved comments

firmware/main.c

@@ -2,7 +2,7 @@
  * \file main.c
  * \brief Firmware for the binary DCF-77 clock
  * \author Ronald Schaten
- * \version $Id: main.c,v 1.1 2007/01/02 21:30:40 rschaten Exp $
+ * \version $Id: main.c,v 1.2 2007/01/03 12:38:55 rschaten Exp $
  *
  * License: See documentation.
  */
@@ -15,21 +15,24 @@
 #include "saa1064.h"
 #include "dcftime.h"
 
-uint8_t byte[4] = { 2, 3, 1, 0 }; /** the order of the connected output-LED-rows */
-uint8_t output[4], outputOld[4]; /** current and old content of the LEDs */
+uint8_t byte[4] = { 2, 3, 1, 0 }; /**< the order of the connected output-LED-rows */
+uint8_t output[4]; /**< current content of the LEDs */
+uint8_t outputOld[4]; /**< old content of the LEDs */
 
 /** the display-modes */
 enum modes {
-    timeasbinary,
-    dateasbinary,
-    timeasbcdhorizontal,
-    dateasbcdhorizontal,
-    timeasbcdvertical,
-    dateasbcdvertical,
-    timestamp
+    timeasbinary, /**< display hours, minutes and seconds, one byte per row */
+    dateasbinary, /**< display day of month, month, year and day of week, one byte per row */
+    timeasbcdhorizontal, /**< display hours, minutes and seconds, two BCDs per row */
+    dateasbcdhorizontal, /**< display day of month, month, year and day of week, two BCDs per row */
+    timeasbcdvertical, /**< display hours, minutes and seconds, one BCD per column */
+    dateasbcdvertical, /**< display day of month, month and year, one BCD per column */
+    timestamp /**< display unix timestamp, one byte per row */
 };
+/** the current display-mode */
 enum modes mode;
 
+/** demo mode active */
 uint8_t demomode = 0;
 
 
@@ -48,7 +51,7 @@ void setLeds(void) {
 
 /**
  * Takes the current time and converts it into different output-formats.
- * \param datetime: the current time
+ * \param datetime the current time
  */
 void setOutput(dcf_datetime datetime) {
     uint8_t bcdlow, bcdhigh; /* takes the low and high parts when converting to BCD */