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.

29 files changed, 148 insertions, 0 deletions

diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h
index 1a950cbc5..008cca169 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h
index 05d085128..2b8075b02 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/BUMBLEB/Buttons.h b/LUFA/Drivers/Board/BUMBLEB/Buttons.h
index d9a0f0b96..240705352 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/BUMBLEB/Joystick.h b/LUFA/Drivers/Board/BUMBLEB/Joystick.h
index 14d7d4698..4ab98ae7f 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/BUMBLEB/LEDs.h b/LUFA/Drivers/Board/BUMBLEB/LEDs.h
index 3eb441204..344a26e9c 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/EVK527/AT45DB321C.h b/LUFA/Drivers/Board/EVK527/AT45DB321C.h
index 74e04c254..ada314d25 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/EVK527/Buttons.h b/LUFA/Drivers/Board/EVK527/Buttons.h
index c945db847..cb8cdc5fd 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/EVK527/Dataflash.h b/LUFA/Drivers/Board/EVK527/Dataflash.h
index 9ffd94611..b6a6e25d8 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/EVK527/Joystick.h b/LUFA/Drivers/Board/EVK527/Joystick.h
index e3f4dd031..c9262a482 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/EVK527/LEDs.h b/LUFA/Drivers/Board/EVK527/LEDs.h
index cfad2224c..a1ba50d82 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h
index e3373458b..088cd3aef 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/STK525/AT45DB321C.h b/LUFA/Drivers/Board/STK525/AT45DB321C.h
index 49fc3df2a..e29a0a5eb 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/STK525/Buttons.h b/LUFA/Drivers/Board/STK525/Buttons.h
index d29e372bb..fbf4f58c1 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/STK525/Dataflash.h b/LUFA/Drivers/Board/STK525/Dataflash.h
index d779f7407..cab1af838 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/STK525/Joystick.h b/LUFA/Drivers/Board/STK525/Joystick.h
index 11abad523..1cb270f3a 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/STK525/LEDs.h b/LUFA/Drivers/Board/STK525/LEDs.h
index ea182f728..39ffa0f8c 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/STK526/AT45DB642D.h b/LUFA/Drivers/Board/STK526/AT45DB642D.h
index caf42047a..bf2973ef3 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/STK526/Buttons.h b/LUFA/Drivers/Board/STK526/Buttons.h
index 2484706db..9aa798a6e 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/STK526/Dataflash.h b/LUFA/Drivers/Board/STK526/Dataflash.h
index 662966345..ff89dce03 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/STK526/Joystick.h b/LUFA/Drivers/Board/STK526/Joystick.h
index 6bbb3b483..a40526a6f 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/STK526/LEDs.h b/LUFA/Drivers/Board/STK526/LEDs.h
index ead9085c1..4e68d6184 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/USBKEY/AT45DB642D.h b/LUFA/Drivers/Board/USBKEY/AT45DB642D.h
index eee50bbe9..a9f48f083 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/USBKEY/Buttons.h b/LUFA/Drivers/Board/USBKEY/Buttons.h
index 7eb9bdacc..606fe81f8 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h
index 46469318e..2ada30039 100644
--- 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. 

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/USBKEY/Joystick.h b/LUFA/Drivers/Board/USBKEY/Joystick.h
index 61760e187..bbb2a1663 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/USBKEY/LEDs.h b/LUFA/Drivers/Board/USBKEY/LEDs.h
index ed3f5a1d8..cccdc9390 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h b/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h
index a616279ec..1df0b4083 100644
--- 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.

+ *

  *  @{

  */

  

diff --git a/LUFA/Drivers/Board/XPLAIN/Dataflash.h b/LUFA/Drivers/Board/XPLAIN/Dataflash.h
index 8832874ac..045d596f1 100644
--- 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.

+ *

  *  @{

  */

 

diff --git a/LUFA/Drivers/Board/XPLAIN/LEDs.h b/LUFA/Drivers/Board/XPLAIN/LEDs.h
index 600be9f26..36d8315b6 100644
--- 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.

+ *

  *  @{

  */