diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
| commit | d38fa49cb6cb3804c9bb17601688a62ba466b535 (patch) | |
| tree | 15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Drivers/Board/Joystick.h | |
| parent | 6380d057f8911f5d09bdffff4220aa9602df49e2 (diff) | |
| download | lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.bz2 lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip | |
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Drivers/Board/Joystick.h')
| -rw-r--r-- | LUFA/Drivers/Board/Joystick.h | 8 |
1 files changed, 8 insertions, 0 deletions
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.
+ *
* @{
*/
|