Commit 5e731905 authored by Dean Camera's avatar Dean Camera
Browse files

Start update of documentation to support possible multiple architectures in...

Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
parent 1daa5e16
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel STK526.
*
* Board specific joystick driver header for the Atmel STK526.
* \copydetails Group_Joystick_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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_STK526 STK526
* \brief Board specific joystick driver header for the Atmel STK526.
*
* Board specific joystick driver header for the Atmel 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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __JOYSTICK_STK526_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel STK526.
*
* Board specific LED driver header for the Atmel STK526.
* \copydetails Group_LEDs_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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_STK526 STK526
* \brief Board specific LED driver header for the Atmel STK526.
*
* Board specific LED driver header for the Atmel 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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_STK526_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).
* \copydetails Group_LEDs_TEENSY
*
* \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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_TEENSY TEENSY
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).
*
* \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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_TEENSY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the UDIP.
*
* Board specific Buttons driver header for the Linnix UDIP (http://linnix.com/udip/).
* \copydetails Group_Buttons_UDIP
*
* \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,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_UDIP UDIP
* \brief Board specific Buttons driver header for the UDIP.
*
* Board specific Buttons driver header for the Linnix UDIP (http://linnix.com/udip/).
*
* \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.
*
* @{
*/
......@@ -52,9 +49,6 @@
#define __BUTTONS_UDIP_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Linnix UDIP.
*
* Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
* \copydetails Group_LEDs_UDIP
*
* \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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_UDIP UDIP
* \brief Board specific LED driver header for the Linnix UDIP.
*
* Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
*
* \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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_UDIP_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Arduino Uno.
*
* Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
* \copydetails Group_LEDs_UNO
*
* \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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_UNO UNO
* \brief Board specific LED driver header for the Arduino Uno.
*
* Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
*
* \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.
*
* @{
*/
......@@ -52,7 +49,7 @@
#define __LEDS_UNO_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Kernel Concepts USBFOO.
*
* Board specific Buttons driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
* \copydetails Group_Buttons_USBFOO
*
* \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,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBFOO USBFOO
* \brief Board specific Buttons driver header for the Kernel Concepts USBFOO.
*
* Board specific Buttons driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
*
* \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.
*
* @{
*/
......@@ -52,9 +49,6 @@
#define __BUTTONS_USBFOO_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Kernel Concepts USBFOO.
*
* Board specific LED driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
* \copydetails Group_LEDs_USBFOO
*
* \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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBFOO USBFOO
* \brief Board specific LED driver header for the Kernel Concepts USBFOO.
*
* Board specific LED driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
*
* \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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_USBFOO_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel USBKEY.
*
* Board specific Buttons driver header for the Atmel USBKEY.
* \copydetails Group_Buttons_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,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBKEY USBKEY
* \brief Board specific Buttons driver header for the Atmel USBKEY.
*
* Board specific Buttons driver header for the Atmel 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.
*
* @{
*/
......@@ -52,9 +49,6 @@
#define __BUTTONS_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel USBKEY.
*
* Board specific Dataflash driver header for the Atmel USBKEY.
* \copydetails Group_Dataflash_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,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_USBKEY USBKEY
* \brief Board specific Dataflash driver header for the Atmel USBKEY.
*
* Board specific Dataflash driver header for the Atmel 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.
*
* @{
*/
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel USBKEY.
*
* Board specific joystick driver header for the Atmel USBKEY.
* \copydetails Group_Joystick_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,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_USBKEY USBKEY
* \brief Board specific joystick driver header for the Atmel USBKEY.
*
* Board specific joystick driver header for the Atmel 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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __JOYSTICK_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel USBKEY.
*
* Board specific LED driver header for the Atmel USBKEY.
* \copydetails Group_LEDs_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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBKEY USBKEY
* \brief Board specific LED driver header for the Atmel USBKEY.
*
* Board specific LED driver header for the Atmel 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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for Tom's USBTINY MKII.
*
* Board specific Buttons driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
* \copydetails Group_Buttons_USBTINYMKII
*
* \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,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBTINYMKII USBTINYMKII
* \brief Board specific Buttons driver header for Tom's USBTINY MKII.
*
* Board specific Buttons driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
*
* \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.
*
* @{
*/
......@@ -52,9 +49,6 @@
#define __BUTTONS_USBTINYMKII_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for Tom's USBTINY MKII.
*
* Board specific LED driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
* \copydetails Group_LEDs_USBTINYMKII
*
* \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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBTINYMKII USBTINYMKII
* \brief Board specific LED driver header for Tom's USBTINY MKII.
*
* Board specific LED driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
*
* \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.
*
* @{
*/
......@@ -52,7 +49,7 @@
#define __LEDS_USBTINYMKII_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel XPLAIN.
*
* Board specific Dataflash driver header for the Atmel XPLAIN.
* \copydetails Group_Dataflash_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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_XPLAIN XPLAIN
* \brief Board specific Dataflash driver header for the Atmel XPLAIN.
*
* Board specific Dataflash driver header for the Atmel 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.
*
* @{
*/
......
......@@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel XPLAIN.
*
* Board specific LED driver header for the Atmel XPLAIN.
* \copydetails Group_LEDs_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.
......@@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_XPLAIN XPLAIN
* \brief Board specific LED driver header for the Atmel XPLAIN.
*
* Board specific LED driver header for the Atmel 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.
*
* @{
*/
......@@ -52,8 +49,6 @@
#define __LEDS_XPLAIN_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
......
......@@ -29,13 +29,13 @@
*/
/** \file
* \brief Dataflash command constants for the the Atmel AT45DB321C Dataflash IC
*
* Dataflash command constants for the Atmel AT45DB321C Dataflash IC.
* \brief Command constants for the Atmel AT45DB321C Dataflash.
* \copydetails Group_AT45DB321C
*/
/** \ingroup Group_MiscDrivers
* \defgroup Group_AT45DB321C AT45DB321C Commands
* \defgroup Group_AT45DB321C Atmel AT45DB321C Dataflash Commands
* \brief Command constants for the Atmel AT45DB321C Dataflash.
*
* Dataflash command constants for the Atmel AT45DB321C Dataflash IC.
*
......
......@@ -29,13 +29,13 @@
*/
/** \file
* \brief Dataflash command constants for the the Atmel AT45DB642D Dataflash IC
*
* Dataflash command constants for the Atmel AT45DB642D Dataflash IC.
* \brief Command constants for the Atmel AT45DB642D Dataflash.
* \copydetails Group_AT45DB642D
*/
/** \ingroup Group_MiscDrivers
* \defgroup Group_AT45DB642D AT45DB642D Commands
* \defgroup Group_AT45DB642D Atmel AT45DB642D Dataflash Commands
* \brief Command constants for the Atmel AT45DB642D Dataflash.
*
* Dataflash command constants for the Atmel AT45DB642D Dataflash IC.
*
......
......@@ -93,10 +93,6 @@
#define __RING_BUFFER_H__
/* Includes: */
#include <util/atomic.h>
#include <stdint.h>
#include <stdbool.h>
#include "../../Common/Common.h"
/* Type Defines: */
......
......@@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment