[tuxdroid-svn] r1189 - firmware/fuxusb/trunk/src

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

Author: Paul_R
Date: 2008-05-22 14:50:02 +0200 (Thu, 22 May 2008)
New Revision: 1189

Modified:
   firmware/fuxusb/trunk/src/config.h
   firmware/fuxusb/trunk/src/global.c
   firmware/fuxusb/trunk/src/global.h
   firmware/fuxusb/trunk/src/i2c.c
   firmware/fuxusb/trunk/src/i2c.h
   firmware/fuxusb/trunk/src/misc.c
   firmware/fuxusb/trunk/src/misc.h
   firmware/fuxusb/trunk/src/rf.c
   firmware/fuxusb/trunk/src/rf.h
   firmware/fuxusb/trunk/src/usb_desc.h
Log:
* Doc.


Modified: firmware/fuxusb/trunk/src/config.h
===================================================================
--- firmware/fuxusb/trunk/src/config.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/config.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -22,15 +22,23 @@
 #ifndef _CONFIG_H_
 #define _CONFIG_H_
 
+/** \file config.h
+ *  \brief Global config.
+ *  \ingroup fuxusb
+ */
+
 #include <stdint.h>
 #include "lib_mcu/compiler.h"
 #include "lib_mcu/reg_5131.h"
 #include "lib_mcu/ext_5131.h"
 #include "lib_mcu/5131_drv.h"
 
-/* Debug modes : Don't forget to define MAIN_DEBUG to be able to use printf */
-//#define MAIN_DEBUG
-//#define USB_ENUM_DEBUG
+/** \name Debug modes
+ * Don't forget to define MAIN_DEBUG to be able to use printf 
+ * @{ */
+#undef MAIN_DEBUG
+#undef USB_ENUM_DEBUG
+/* @} */
 
 /** \name MCU config 
  * @{ */
@@ -44,9 +52,11 @@
 #define BDR_GENERATOR BRG_TIMER2
 /* @} */
 
-/* Misc */
+/** \name Misc 
+ * @{ */
 #define False 0
 #define True 1
+/* @} */
 
 /** \name Endpoints
  * @{ */

Modified: firmware/fuxusb/trunk/src/global.c
===================================================================
--- firmware/fuxusb/trunk/src/global.c	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/global.c	2008-05-22 12:50:02 UTC (rev 1189)
@@ -19,6 +19,11 @@
 
 /* $Id$ */
 
+/** \file global.c
+ *  \brief Global variables.
+ *  \ingroup fuxusb
+ */
+
 #include "global.h"
 #include "config.h"
 #include "version.h"

Modified: firmware/fuxusb/trunk/src/global.h
===================================================================
--- firmware/fuxusb/trunk/src/global.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/global.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -70,6 +70,7 @@
  */
 
 /** \defgroup usb_misc USB misc functions
+ *  \brief USB misc functions.
  *  \ingroup fuxusb
  */
 
@@ -133,12 +134,17 @@
 /** \defgroup misc Misc
  *  \brief Misc functions.
  *  \ingroup fuxusb
- */
-
+ */  
+ 
 /** 
  * \defgroup mcu MCU libs
  */
 
+/** \file global.h
+ *  \brief Global variables - header.
+ *  \ingroup fuxusb
+ */
+
 #include "common\api.h"
 #include "common\defines.h"
 

Modified: firmware/fuxusb/trunk/src/i2c.c
===================================================================
--- firmware/fuxusb/trunk/src/i2c.c	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/i2c.c	2008-05-22 12:50:02 UTC (rev 1189)
@@ -20,6 +20,7 @@
 /* $Id$ */
 
 /** \file i2c.c
+ *  \brief I2C communication functions.
     \ingroup i2c
 */
 

Modified: firmware/fuxusb/trunk/src/i2c.h
===================================================================
--- firmware/fuxusb/trunk/src/i2c.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/i2c.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -20,6 +20,7 @@
 /* $Id$ */
 
 /** \file i2c.h
+ *  \brief I2C communication.
     \ingroup i2c
 */
 

Modified: firmware/fuxusb/trunk/src/misc.c
===================================================================
--- firmware/fuxusb/trunk/src/misc.c	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/misc.c	2008-05-22 12:50:02 UTC (rev 1189)
@@ -21,6 +21,7 @@
 
 
 /** \file misc.c
+ *  \brief Misc functions.
     \ingroup misc
 */
 

Modified: firmware/fuxusb/trunk/src/misc.h
===================================================================
--- firmware/fuxusb/trunk/src/misc.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/misc.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -21,6 +21,7 @@
 
 
 /** \file misc.h
+ *  \brief Misc. module declaration.
     \ingroup misc
 */
 

Modified: firmware/fuxusb/trunk/src/rf.c
===================================================================
--- firmware/fuxusb/trunk/src/rf.c	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/rf.c	2008-05-22 12:50:02 UTC (rev 1189)
@@ -20,6 +20,7 @@
 /* $Id$ */
 
 /** \file rf.c
+ *  \brief Functions to control the RF.
     \ingroup rf
  */
 #include "config.h"

Modified: firmware/fuxusb/trunk/src/rf.h
===================================================================
--- firmware/fuxusb/trunk/src/rf.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/rf.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -21,6 +21,7 @@
 
 
 /** \file rf.h
+ *  \brief RF module declaration.
     \ingroup rf
 */
 

Modified: firmware/fuxusb/trunk/src/usb_desc.h
===================================================================
--- firmware/fuxusb/trunk/src/usb_desc.h	2008-05-22 09:48:32 UTC (rev 1188)
+++ firmware/fuxusb/trunk/src/usb_desc.h	2008-05-22 12:50:02 UTC (rev 1189)
@@ -30,7 +30,7 @@
 #include "version.h"
 
 /** Enable / Disable the HID interface */
-#undef HID_DEVICE
+#define HID_DEVICE
 
 /** \name Descriptors type
  * @{ */