aboutsummaryrefslogtreecommitdiff
path: root/LUFA/Drivers/Board
diff options
context:
space:
mode:
authorDean Camera <[email protected]>2009-04-17 05:04:21 +0000
committerDean Camera <[email protected]>2009-04-17 05:04:21 +0000
commitd38fa49cb6cb3804c9bb17601688a62ba466b535 (patch)
tree15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Drivers/Board
parent6380d057f8911f5d09bdffff4220aa9602df49e2 (diff)
downloadqmk_firmware-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz
qmk_firmware-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Drivers/Board')
-rw-r--r--LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h7
-rw-r--r--LUFA/Drivers/Board/Dataflash.h8
-rw-r--r--LUFA/Drivers/Board/HWB.h8
-rw-r--r--LUFA/Drivers/Board/Joystick.h8
-rw-r--r--LUFA/Drivers/Board/LEDs.h8
-rw-r--r--LUFA/Drivers/Board/STK525/HWB.h7
-rw-r--r--LUFA/Drivers/Board/STK526/HWB.h8
-rw-r--r--LUFA/Drivers/Board/Temperature.h5
-rw-r--r--LUFA/Drivers/Board/USBKEY/HWB.h7
9 files changed, 37 insertions, 29 deletions
diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h b/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h
index 9d9982ba22..87426de160 100644
--- a/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h
+++ b/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h
@@ -36,12 +36,6 @@
* dispatch header located in LUFA/Drivers/Board/HWB.h.
*/
-/** \ingroup Group_HWB
- * @defgroup Group_HWB_ATAVRUSBRF01 ATAVRUSBRF01
- *
- * @{
- */
-
#ifndef __HWB_ATAVRUSBRF01_H__
#define __HWB_ATAVRUSBRF01_H__
@@ -84,4 +78,3 @@
#endif
-/** @} */
diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index c235cf3190..9f5d0756d5 100644
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -43,8 +43,16 @@
/** \ingroup Group_BoardDrivers
* @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
*
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Module Description
* Functions, macros, variables, enums and types related to the control of board Dataflash ICs.
*
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
+ * directory. Otherwise, it will include the appropriate built in board driver header file.
+ *
* @{
*/
diff --git a/LUFA/Drivers/Board/HWB.h b/LUFA/Drivers/Board/HWB.h
index 049fd2378d..f6221afd3b 100644
--- a/LUFA/Drivers/Board/HWB.h
+++ b/LUFA/Drivers/Board/HWB.h
@@ -43,8 +43,16 @@
/** \ingroup Group_BoardDrivers
* @defgroup Group_HWB HWB Driver - LUFA/Drivers/Board/HWB.h
*
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Module Description
* Functions, macros, variables, enums and types related to the control of board HWB.
*
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
+ * directory. Otherwise, it will include the appropriate built in board driver header file.
+ *
* @{
*/
diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 86a02cfe72..c7eb313b8c 100644
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -43,8 +43,16 @@
/** \ingroup Group_BoardDrivers
* @defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
*
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Module Description
* Functions, macros, variables, enums and types related to the control of board joystick.
*
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
+ * directory. Otherwise, it will include the appropriate built in board driver header file.
+ *
* @{
*/
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index c40042ddc9..1874dfde3b 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -43,8 +43,16 @@
/** \ingroup Group_BoardDrivers
* @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
*
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Module Description
* Functions, macros, variables, enums and types related to the control of board LEDs.
*
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
+ * directory. Otherwise, it will include the appropriate built in board driver header file.
+ *
* @{
*/
diff --git a/LUFA/Drivers/Board/STK525/HWB.h b/LUFA/Drivers/Board/STK525/HWB.h
index a91890cd35..2200453ee8 100644
--- a/LUFA/Drivers/Board/STK525/HWB.h
+++ b/LUFA/Drivers/Board/STK525/HWB.h
@@ -36,12 +36,6 @@
* dispatch header located in LUFA/Drivers/Board/HWB.h.
*/
-/** \ingroup Group_HWB
- * @defgroup Group_HWB_STK525 STK525
- *
- * @{
- */
-
#ifndef __HWB_STK525_H__
#define __HWB_STK525_H__
@@ -84,4 +78,3 @@
#endif
-/** @} */
diff --git a/LUFA/Drivers/Board/STK526/HWB.h b/LUFA/Drivers/Board/STK526/HWB.h
index 0d4fd7e03d..6f1861bc15 100644
--- a/LUFA/Drivers/Board/STK526/HWB.h
+++ b/LUFA/Drivers/Board/STK526/HWB.h
@@ -36,12 +36,6 @@
* dispatch header located in LUFA/Drivers/Board/HWB.h.
*/
-/** \ingroup Group_HWB
- * @defgroup Group_HWB_STK526 STK526
- *
- * @{
- */
-
#ifndef __HWB_STK526_H__
#define __HWB_STK526_H__
@@ -83,5 +77,3 @@
#endif
#endif
-
-/** @} */
diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index 7069e3e990..f21ed400d2 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -36,6 +36,11 @@
/** \ingroup Group_BoardDrivers
* @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h
*
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/Board/Temperature.c
+ *
+ * \section Module Description
* Functions, macros, variables, enums and types related to the control of board temperature sensors.
*
* @{
diff --git a/LUFA/Drivers/Board/USBKEY/HWB.h b/LUFA/Drivers/Board/USBKEY/HWB.h
index bfbaa4940c..13af186a07 100644
--- a/LUFA/Drivers/Board/USBKEY/HWB.h
+++ b/LUFA/Drivers/Board/USBKEY/HWB.h
@@ -36,12 +36,6 @@
* dispatch header located in LUFA/Drivers/Board/HWB.h.
*/
-/** \ingroup Group_HWB
- * @defgroup Group_HWB_USBKEY USBKEY
- *
- * @{
- */
-
#ifndef __HWB_USBKEY_H__
#define __HWB_USBKEY_H__
@@ -84,4 +78,3 @@
#endif
-/** @} */