Make board specific and device peripheral specific drivers' file documentation copy...
authorDean Camera <dean@fourwalledcubicle.com>
Mon, 1 Feb 2010 10:34:07 +0000 (10:34 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Mon, 1 Feb 2010 10:34:07 +0000 (10:34 +0000)
30 files changed:
LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h
LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h
LUFA/Drivers/Board/BUMBLEB/Buttons.h
LUFA/Drivers/Board/BUMBLEB/Joystick.h
LUFA/Drivers/Board/BUMBLEB/LEDs.h
LUFA/Drivers/Board/EVK527/AT45DB321C.h
LUFA/Drivers/Board/EVK527/Buttons.h
LUFA/Drivers/Board/EVK527/Dataflash.h
LUFA/Drivers/Board/EVK527/Joystick.h
LUFA/Drivers/Board/EVK527/LEDs.h
LUFA/Drivers/Board/RZUSBSTICK/LEDs.h
LUFA/Drivers/Board/STK525/AT45DB321C.h
LUFA/Drivers/Board/STK525/Buttons.h
LUFA/Drivers/Board/STK525/Dataflash.h
LUFA/Drivers/Board/STK525/Joystick.h
LUFA/Drivers/Board/STK525/LEDs.h
LUFA/Drivers/Board/STK526/AT45DB642D.h
LUFA/Drivers/Board/STK526/Buttons.h
LUFA/Drivers/Board/STK526/Dataflash.h
LUFA/Drivers/Board/STK526/Joystick.h
LUFA/Drivers/Board/STK526/LEDs.h
LUFA/Drivers/Board/USBKEY/AT45DB642D.h
LUFA/Drivers/Board/USBKEY/Buttons.h
LUFA/Drivers/Board/USBKEY/Dataflash.h
LUFA/Drivers/Board/USBKEY/Joystick.h
LUFA/Drivers/Board/USBKEY/LEDs.h
LUFA/Drivers/Board/XPLAIN/AT45DB642D.h
LUFA/Drivers/Board/XPLAIN/Dataflash.h
LUFA/Drivers/Board/XPLAIN/LEDs.h
LUFA/ManPages/LibraryResources.txt

index 1a950cb..008cca1 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_ATAVRUSBRF01 ATAVRUSBRF01\r
  *\r
+ *  Board specific Buttons driver header for the ATAVRUSBRF01.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 05d0851..2b8075b 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_ATAVRUSBRF01 ATAVRUSBRF01\r
  *\r
+ *  Board specific LED driver header for the ATAVRUSBRF01.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index d9a0f0b..2407053 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_BUMBLEB BUMBLEB\r
  *\r
+ *  Board specific Buttons driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board\r
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 14d7d46..4ab98ae 100644 (file)
 /** \ingroup Group_Joystick\r
  *  @defgroup Group_Joystick_BUMBLEB BUMBLEB\r
  *\r
+ *  Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board\r
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 3eb4412..344a26e 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_BUMBLEB BUMBLEB\r
  *\r
+ *  Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board\r
+ *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 74e04c2..ada314d 100644 (file)
 /** \ingroup Group_Dataflash_EVK527\r
  *  @defgroup Group_Dataflash_EVK527_AT45DB321C AT45DB321C\r
  *\r
+ *  Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index c945db8..cb8cdc5 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_EVK527 EVK527\r
  *\r
+ *  Board specific Buttons driver header for the EVK527.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 9ffd946..b6a6e25 100644 (file)
 /** \ingroup Group_Dataflash\r
  *  @defgroup Group_Dataflash_EVK527 EVK527\r
  *\r
+ *  Board specific Dataflash driver header for the EVK527.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index e3f4dd0..c9262a4 100644 (file)
 /** \ingroup Group_Joystick\r
  *  @defgroup Group_Joystick_EVK527 EVK527\r
  *\r
+ *  Board specific joystick driver header for the EVK527.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index cfad222..a1ba50d 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_EVK527 EVK527\r
  *\r
+ *  Board specific LED driver header for the EVK527.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index e337345..088cd3a 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_RZUSBSTICK RZUSBSTICK\r
  *\r
+ *  Board specific LED driver header for the RZUSBSTICK.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index 49fc3df..e29a0a5 100644 (file)
 /** \ingroup Group_Dataflash_STK525\r
  *  @defgroup Group_Dataflash_STK525_AT45DB321C AT45DB321C\r
  *\r
+ *  Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index d29e372..fbf4f58 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_STK525 STK525\r
  *\r
+ *  Board specific Buttons driver header for the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index d779f74..cab1af8 100644 (file)
 /** \ingroup Group_Dataflash\r
  *  @defgroup Group_Dataflash_STK525 STK525\r
  *\r
+ *  Board specific Dataflash driver header for the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 11abad5..1cb270f 100644 (file)
 /** \ingroup Group_Joystick\r
  *  @defgroup Group_Joystick_STK525 STK525\r
  *\r
+ *  Board specific joystick driver header for the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index ea182f7..39ffa0f 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_STK525 STK525\r
  *\r
+ *  Board specific LED driver header for the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index caf4204..bf2973e 100644 (file)
 /** \ingroup Group_Dataflash_STK526\r
  *  @defgroup Group_Dataflash_STK526_AT45DB642D AT45DB642D\r
  *\r
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 2484706..9aa798a 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_STK526 STK526\r
  *\r
+ *  Board specific Buttons driver header for the STK526.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 6629663..ff89dce 100644 (file)
 /** \ingroup Group_Dataflash\r
  *  @defgroup Group_Dataflash_STK526 STK526\r
  *\r
+ *  Board specific Dataflash driver header for the STK525.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 6bbb3b4..a40526a 100644 (file)
 /** \ingroup Group_Joystick\r
  *  @defgroup Group_Joystick_STK526 STK526\r
  *\r
+ *  Board specific joystick driver header for the STK526.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index ead9085..4e68d61 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_STK526 STK526\r
  *\r
+ *  Board specific LED driver header for the STK526.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index eee50bb..a9f48f0 100644 (file)
 /** \ingroup Group_Dataflash_USBKEY\r
  *  @defgroup Group_Dataflash_USBKEY_AT45DB642D AT45DB642D\r
  *\r
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index 7eb9bda..606fe81 100644 (file)
 /** \ingroup Group_Buttons\r
  *  @defgroup Group_Buttons_USBKEY USBKEY\r
  *\r
+ *  Board specific Buttons driver header for the USBKEY.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 4646931..2ada300 100644 (file)
 /** \ingroup Group_Dataflash\r
  *  @defgroup Group_Dataflash_USBKEY USBKEY\r
  *\r
+ *  Board specific Dataflash driver header for the USBKEY board.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h. \r
+ *\r
  *  @{\r
  */\r
 \r
index 61760e1..bbb2a16 100644 (file)
 /** \ingroup Group_Joystick\r
  *  @defgroup Group_Joystick_USBKEY USBKEY\r
  *\r
+ *  Board specific joystick driver header for the USBKEY.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index ed3f5a1..cccdc93 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_USBKEY USBKEY\r
  *\r
+ *  Board specific LED driver header for the USBKEY.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index a616279..1df0b40 100644 (file)
 /** \ingroup Group_Dataflash_XPLAIN\r
  *  @defgroup Group_Dataflash_XPLAIN_AT45DB642D AT45DB642D\r
  *\r
+ *  Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index 8832874..045d596 100644 (file)
 /** \ingroup Group_Dataflash\r
  *  @defgroup Group_Dataflash_XPLAIN XPLAIN\r
  *\r
+ *  Board specific Dataflash driver header for the XPLAIN.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
+ *\r
  *  @{\r
  */\r
 \r
index 600be9f..36d8315 100644 (file)
 /** \ingroup Group_LEDs\r
  *  @defgroup Group_LEDs_XPLAIN XPLAIN\r
  *\r
+ *  Board specific LED driver header for the XPLAIN.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ *\r
  *  @{\r
  */\r
  \r
index f669de3..4d1115d 100644 (file)
@@ -7,18 +7,26 @@
 /**\r
  *  \page Page_Resources Library Resources\r
  *\r
+ *  \section Sec_ProjectPages LUFA Related Webpages\r
  *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n\r
+ *  Author's Website: http://www.fourwalledcubicle.com \n\r
  *  Development Blog: http://www.fourwalledcubicle.com/blog \n\r
+ *\r
+ *  \section Sec_ProjectHelp Assistance With LUFA\r
  *  Discussion Group: http://groups.google.com/group/myusb-support-list \n\r
+ *  Author's Email: dean [at] fourwalledcubicle [dot] com\r
+ *\r
+ *  \section Sec_InDevelopment Latest In-Development Source Code\r
  *  Official Releases, SVN Access, Issue Tracker: http://code.google.com/p/lufa-lib/ \n\r
- *  Development Source Archives: http://github.com/abcminiuser/lufa-lib/archives/master\r
- *  Git Access: http://github.com/abcminiuser/lufa-lib\r
- *  Commit RSS: http://github.com/feeds/abcminiuser/commits/lufa-lib/master\r
- *  Author's Website: http://www.fourwalledcubicle.com \n\r
+ *  Git Access: http://github.com/abcminiuser/lufa-lib \n\r
+ *  Development Source Archives: http://github.com/abcminiuser/lufa-lib/archives/master \n\r
+ *  Commit RSS Feed: http://github.com/feeds/abcminiuser/commits/lufa-lib/master \n\r
  *\r
+ *  \section Sec_Toolchain AVR Toolchain\r
  *  WinAVR Website: http://winavr.sourceforge.net \n\r
  *  avr-libc Website: http://www.nongnu.org/avr-libc/ \n\r
  *\r
+ *  \section Sec_USBResources USB Resources\r
  *  USB-IF Website: http://www.usb.org \n\r
  */\r
  
\ No newline at end of file