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.

15 years ago · a4ebf4e920
parent 2ae397dc2f
commit a4ebf4e920
30 changed files with 160 additions and 4 deletions
--- a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h
+++ b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_ATAVRUSBRF01 ATAVRUSBRF01
 *
+ *  Board specific Buttons driver header for the ATAVRUSBRF01.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h
+++ b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_ATAVRUSBRF01 ATAVRUSBRF01
 *
+ *  Board specific LED driver header for the ATAVRUSBRF01.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/BUMBLEB/Buttons.h
+++ b/LUFA/Drivers/Board/BUMBLEB/Buttons.h
@ -40,6 +40,12 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_BUMBLEB BUMBLEB
 *
+ *  Board specific Buttons driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/BUMBLEB/Joystick.h
+++ b/LUFA/Drivers/Board/BUMBLEB/Joystick.h
@ -40,6 +40,12 @@
 /** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_BUMBLEB BUMBLEB
 *
+ *  Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/BUMBLEB/LEDs.h
+++ b/LUFA/Drivers/Board/BUMBLEB/LEDs.h
@ -40,6 +40,12 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_BUMBLEB BUMBLEB
 *
+ *  Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/EVK527/AT45DB321C.h
+++ b/LUFA/Drivers/Board/EVK527/AT45DB321C.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash_EVK527
 *  @defgroup Group_Dataflash_EVK527_AT45DB321C AT45DB321C
 *
+ *  Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/EVK527/Buttons.h
+++ b/LUFA/Drivers/Board/EVK527/Buttons.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_EVK527 EVK527
 *
+ *  Board specific Buttons driver header for the EVK527.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/EVK527/Dataflash.h
+++ b/LUFA/Drivers/Board/EVK527/Dataflash.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash
 *  @defgroup Group_Dataflash_EVK527 EVK527
 *
+ *  Board specific Dataflash driver header for the EVK527.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/EVK527/Joystick.h
+++ b/LUFA/Drivers/Board/EVK527/Joystick.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_EVK527 EVK527
 *
+ *  Board specific joystick driver header for the EVK527.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/EVK527/LEDs.h
+++ b/LUFA/Drivers/Board/EVK527/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_EVK527 EVK527
 *
+ *  Board specific LED driver header for the EVK527.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h
+++ b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_RZUSBSTICK RZUSBSTICK
 *
+ *  Board specific LED driver header for the RZUSBSTICK.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/STK525/AT45DB321C.h
+++ b/LUFA/Drivers/Board/STK525/AT45DB321C.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash_STK525
 *  @defgroup Group_Dataflash_STK525_AT45DB321C AT45DB321C
 *
+ *  Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/STK525/Buttons.h
+++ b/LUFA/Drivers/Board/STK525/Buttons.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_STK525 STK525
 *
+ *  Board specific Buttons driver header for the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/STK525/Dataflash.h
+++ b/LUFA/Drivers/Board/STK525/Dataflash.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash
 *  @defgroup Group_Dataflash_STK525 STK525
 *
+ *  Board specific Dataflash driver header for the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/STK525/Joystick.h
+++ b/LUFA/Drivers/Board/STK525/Joystick.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_STK525 STK525
 *
+ *  Board specific joystick driver header for the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/STK525/LEDs.h
+++ b/LUFA/Drivers/Board/STK525/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_STK525 STK525
 *
+ *  Board specific LED driver header for the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/STK526/AT45DB642D.h
+++ b/LUFA/Drivers/Board/STK526/AT45DB642D.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash_STK526
 *  @defgroup Group_Dataflash_STK526_AT45DB642D AT45DB642D
 *
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/STK526/Buttons.h
+++ b/LUFA/Drivers/Board/STK526/Buttons.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Buttons
 *  @defgroup Group_Buttons_STK526 STK526
 *
+ *  Board specific Buttons driver header for the STK526.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/STK526/Dataflash.h
+++ b/LUFA/Drivers/Board/STK526/Dataflash.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash
 *  @defgroup Group_Dataflash_STK526 STK526
 *
+ *  Board specific Dataflash driver header for the STK525.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/STK526/Joystick.h
+++ b/LUFA/Drivers/Board/STK526/Joystick.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_STK526 STK526
 *
+ *  Board specific joystick driver header for the STK526.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/STK526/LEDs.h
+++ b/LUFA/Drivers/Board/STK526/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_STK526 STK526
 *
+ *  Board specific LED driver header for the STK526.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/USBKEY/AT45DB642D.h
+++ b/LUFA/Drivers/Board/USBKEY/AT45DB642D.h
@ -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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/USBKEY/Buttons.h
+++ b/LUFA/Drivers/Board/USBKEY/Buttons.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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/USBKEY/Dataflash.h
+++ b/LUFA/Drivers/Board/USBKEY/Dataflash.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. 
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/USBKEY/Joystick.h
+++ b/LUFA/Drivers/Board/USBKEY/Joystick.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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/USBKEY/LEDs.h
+++ b/LUFA/Drivers/Board/USBKEY/LEDs.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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h
+++ b/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash_XPLAIN
 *  @defgroup Group_Dataflash_XPLAIN_AT45DB642D AT45DB642D
 *
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/Drivers/Board/XPLAIN/Dataflash.h
+++ b/LUFA/Drivers/Board/XPLAIN/Dataflash.h
@ -39,6 +39,11 @@
 /** \ingroup Group_Dataflash
 *  @defgroup Group_Dataflash_XPLAIN XPLAIN
 *
+ *  Board specific Dataflash driver header for the XPLAIN.
+ *
+ *  \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.
+ *
 *  @{
 */

--- a/LUFA/Drivers/Board/XPLAIN/LEDs.h
+++ b/LUFA/Drivers/Board/XPLAIN/LEDs.h
@ -39,6 +39,11 @@
 /** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_XPLAIN XPLAIN
 *
+ *  Board specific LED driver header for the XPLAIN.
+ *
+ *  \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.
+ *
 *  @{
 */
 
--- a/LUFA/ManPages/LibraryResources.txt
+++ b/LUFA/ManPages/LibraryResources.txt
@ -7,18 +7,26 @@
 /**
 *  \page Page_Resources Library Resources
 *
+ *  \section Sec_ProjectPages LUFA Related Webpages
 *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n
+ *  Author's Website: http://www.fourwalledcubicle.com \n
 *  Development Blog: http://www.fourwalledcubicle.com/blog \n
+ *
+ *  \section Sec_ProjectHelp Assistance With LUFA
 *  Discussion Group: http://groups.google.com/group/myusb-support-list \n
+ *  Author's Email: dean [at] fourwalledcubicle [dot] com
+ *
+ *  \section Sec_InDevelopment Latest In-Development Source Code
 *  Official Releases, SVN Access, Issue Tracker: http://code.google.com/p/lufa-lib/ \n
- *  Development Source Archives: http://github.com/abcminiuser/lufa-lib/archives/master
- *  Git Access: http://github.com/abcminiuser/lufa-lib
- *  Commit RSS: http://github.com/feeds/abcminiuser/commits/lufa-lib/master
- *  Author's Website: http://www.fourwalledcubicle.com \n
+ *  Git Access: http://github.com/abcminiuser/lufa-lib \n
+ *  Development Source Archives: http://github.com/abcminiuser/lufa-lib/archives/master \n
+ *  Commit RSS Feed: http://github.com/feeds/abcminiuser/commits/lufa-lib/master \n
 *
+ *  \section Sec_Toolchain AVR Toolchain
 *  WinAVR Website: http://winavr.sourceforge.net \n
 *  avr-libc Website: http://www.nongnu.org/avr-libc/ \n
 *
+ *  \section Sec_USBResources USB Resources
 *  USB-IF Website: http://www.usb.org \n
 */