Carousel documentation converted to module

diff --git a/src/Doxyfile b/src/Doxyfile
index b0766e3038f006cd1b3dede54c53cb5cfa88ada7..19dd93f8581f17fbfce4688905e3aec6aa224642 100644 (file)
--- a/src/Doxyfile
+++ b/src/Doxyfile
@@ -873,7 +873,7 @@ ENUM_VALUES_PER_LINE   = 4
 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
 # respectively.
 
-GENERATE_TREEVIEW      = ALL
+GENERATE_TREEVIEW      = NONE
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
 # used to set the initial width (in pixels) of the frame in which the tree 

diff --git a/src/carousel/carousel.c b/src/carousel/carousel.c
index b371907f6e30a78c213dab002534535d3d038b39..f2f522bdc6f61ee5917e5f82a81458ed155e060d 100644 (file)
--- a/src/carousel/carousel.c
+++ b/src/carousel/carousel.c
@@ -1,3 +1,25 @@
+/**
+ * @file carousel.c
+ * 
+ *
+ * @author Ondrej Vrzal, ondra.vrzal@gmail.com
+ *
+ * @addtogroup carousel
+ */
+
+/**
+ * @defgroup carousel Carousel application
+ * 
+ * Carousel control application
+ * - controlls the carousel wheel used in robot for eurobot 2008
+ * - program recieves CAN commands about wanted carousel position
+ * - program moves the carousel 
+ * - sends on CAN the carousel position
+ */
+/**
+ * @ingroup carousel
+ * @{
+ */
 
 #include <deb_led.h>
 #include <uart.h>
@@ -26,18 +48,6 @@
 
 #define GLOBALTIMEOUT 6000 ///< the timeout for carousel to reach requested position
 
-/**
- * @file
- * 
- * Program carousel 
- * - controll the carousel wheel used in robot for eurobot 2008
- * - program recieves CAN commands about wanted carousel position
- * - program moves the carousel 
- * - sends on CAN the carousel position
- *
- * @author Ondrej Vrzal, ondra.vrzal@gmail.com
- */
-
 
 enum Event {EVENT_ENTRY, EVENT_DO, EVENT_EXIT}; ///< events of each state of state machine
 
@@ -1345,3 +1355,5 @@ void delay(int interval)
        unsigned int myTime= getTime();
        while( getTime()< (myTime+interval) );
 }
+
+/** @} */

diff --git a/src/doxygen-mainpage.h b/src/doxygen-mainpage.h
index eb2946150b9bd06dd6a1163e23630ca16725318f..db1b28a988052c7fa4e9f719e76d050a68d0a6a2 100644 (file)
--- a/src/doxygen-mainpage.h
+++ b/src/doxygen-mainpage.h
@@ -14,7 +14,7 @@ Currently, there is documentation to these parts:
 - \ref uoled
 - \ref leds
 - \ref canmsg
-- carousel.c TODO - convert to module
+- \ref carousel
 
 To regenerate this documentation, run @c doxygen in @c src
 directory. The result can be found in @c src/doc/html/index.html.