michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Dean Camera
2009-04-17 05:04:21 +00:00
parent 6380d057f8
commit d38fa49cb6
61 changed files with 414 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h
View File

@@ -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
/** @} */

8
LUFA/Drivers/Board/Dataflash.h
View File

@@ -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.
*
* @{
*/

8
LUFA/Drivers/Board/HWB.h
View File

@@ -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.
*
* @{
*/

8
LUFA/Drivers/Board/Joystick.h
View File

@@ -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.
*
* @{
*/

8
LUFA/Drivers/Board/LEDs.h
View File

@@ -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.
*
* @{
*/

7
LUFA/Drivers/Board/STK525/HWB.h
View File

@@ -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
/** @} */

8
LUFA/Drivers/Board/STK526/HWB.h
View File

@@ -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
/** @} */

5
LUFA/Drivers/Board/Temperature.h
View File

@@ -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.
*
* @{

7
LUFA/Drivers/Board/USBKEY/HWB.h
View File

@@ -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
/** @} */