Make board specific and device peripheral specific drivers' file documentation copy over to the module documentation, so that it is visible in the normal module view of the library documentation.

2010-02-01 10:34:07 +00:00
parent 2ae397dc2f
commit a4ebf4e920
30 changed files with 162 additions and 6 deletions
@@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash_USBKEY
 *  @defgroup Group_Dataflash_USBKEY_AT45DB642D AT45DB642D
 *
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
+ *
 *  @{
 */
 
@@ -39,6 +39,11 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_USBKEY USBKEY
 *
+ *  Board specific Buttons driver header for the USBKEY.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
+ *
 *  @{
 */

@@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash
 *  @defgroup Group_Dataflash_USBKEY USBKEY
 *
+ *  Board specific Dataflash driver header for the USBKEY board.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h. 
+ *
 *  @{
 */

@@ -39,6 +39,11 @@
 /** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_USBKEY USBKEY
 *
+ *  Board specific joystick driver header for the USBKEY.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
+ *
 *  @{
 */

@@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_USBKEY USBKEY
 *
+ *  Board specific LED driver header for the USBKEY.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
+ *
 *  @{
 */