[tuxdroid-svn] r508 - firmware/tuxcore/trunk

[jaguarondi <c2m...@c2...>]

Author: jaguarondi
Date: 2007-09-11 16:07:55 +0200 (Tue, 11 Sep 2007)
New Revision: 508

Modified:
   firmware/tuxcore/trunk/fifo.c
   firmware/tuxcore/trunk/fifo.h
   firmware/tuxcore/trunk/led.c
   firmware/tuxcore/trunk/led.h
Log:
* Minor change on doxygen comments.



Modified: firmware/tuxcore/trunk/fifo.c
===================================================================
--- firmware/tuxcore/trunk/fifo.c	2007-09-10 14:59:45 UTC (rev 507)
+++ firmware/tuxcore/trunk/fifo.c	2007-09-11 14:07:55 UTC (rev 508)
@@ -19,16 +19,16 @@
 
 /* $Id$ */
 
+/** \file fifo.c
+    \brief Circular buffer (FIFO)
+*/
+
 #include <inttypes.h>
 #include "fifo.h"
 
 /** \weakgroup circular_buffer */
 /*! @{ */
 
-/** \file fifo.c
-    \brief Circular buffer (FIFO)
-*/
-
 /** \brief Empty the buffer by clearing the indexes.
  *  \param p Fifo pointer.
  */

Modified: firmware/tuxcore/trunk/fifo.h
===================================================================
--- firmware/tuxcore/trunk/fifo.h	2007-09-10 14:59:45 UTC (rev 507)
+++ firmware/tuxcore/trunk/fifo.h	2007-09-11 14:07:55 UTC (rev 508)
@@ -19,6 +19,24 @@
 
 /* $Id$ */
 
+/** \file fifo.h
+    \ingroup circular_buffer
+    \brief Circular buffer (FIFO)
+
+    \section Internals
+
+    These routines are inspired from an article in Jack Ganssle's Embedded
+    Muse: http://www.ganssle.com/tem/tem110.pdf
+
+    The buffer size must be a power of 2 and is limited to 128. This simplyfies
+    the wrap-around to a single AND operation which is only applied when
+    accessing the buffer but not applied on the in and out indexes. The indexes
+    increase from 0 to 255 then wrap to 0. With this method, the buffer is
+    empty when the indexes are equal and is full when the difference is equal
+    to the buffer size. Thus we can't use a buffer of 256 as it wouldn't be
+    possible to differentiate the buffer when it's empty or full.
+*/
+
 #ifndef _FIFO_H_
 #define _FIFO_H_
 
@@ -55,24 +73,6 @@
     them with FifoPointer().
 */
 
-/** \file fifo.h
-    \ingroup circular_buffer
-    \brief Circular buffer (FIFO)
-
-    \section Internals
-
-    These routines are inspired from an article in Jack Ganssle's Embedded
-    Muse: http://www.ganssle.com/tem/tem110.pdf
-
-    The buffer size must be a power of 2 and is limited to 128. This simplyfies
-    the wrap-around to a single AND operation which is only applied when
-    accessing the buffer but not applied on the in and out indexes. The indexes
-    increase from 0 to 255 then wrap to 0. With this method, the buffer is
-    empty when the indexes are equal and is full when the difference is equal
-    to the buffer size. Thus we can't use a buffer of 256 as it wouldn't be
-    possible to differentiate the buffer when it's empty or full.
-*/
-
 /*
  * Hidden from the interface
  */

Modified: firmware/tuxcore/trunk/led.c
===================================================================
--- firmware/tuxcore/trunk/led.c	2007-09-10 14:59:45 UTC (rev 507)
+++ firmware/tuxcore/trunk/led.c	2007-09-11 14:07:55 UTC (rev 508)
@@ -19,6 +19,11 @@
 
 /* $Id$ */
 
+/** \file led.c
+    \brief Blue leds control module
+    \ingroup led
+*/
+
 #include "global.h"
 #include "hardware.h"
 #include "led.h"

Modified: firmware/tuxcore/trunk/led.h
===================================================================
--- firmware/tuxcore/trunk/led.h	2007-09-10 14:59:45 UTC (rev 507)
+++ firmware/tuxcore/trunk/led.h	2007-09-11 14:07:55 UTC (rev 508)
@@ -26,14 +26,10 @@
 */
 
 /** \file led.h
-    \ingroup movements
+    \brief Blue leds control interface
+    \ingroup led
 */
 
-/** \file led.c
-    \ingroup movements
-*/
-
-
 #ifndef LED_H
 #define LED_H