More documentation changes for better module-level documentation rather than file-level documentation.

9 files changed, 37 insertions, 29 deletions

diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h b/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h
index 9d9982ba2..87426de16 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 c235cf319..9f5d0756d 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 049fd2378..f6221afd3 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 86a02cfe7..c7eb313b8 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 c40042ddc..1874dfde3 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 a91890cd3..2200453ee 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 0d4fd7e03..6f1861bc1 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 7069e3e99..f21ed400d 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 bfbaa4940..13af186a0 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

 

-/** @} */