Ensure core library documentation sections use unique IDs.
This commit is contained in:
Dean Camera
@@ -47,7 +47,7 @@
|
||||
* \defgroup Group_BoardInfo Board Information Driver - LUFA/Drivers/Board/Board.h
|
||||
* \brief Board hardware information driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_BoardInfo_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
|
||||
@@ -47,11 +47,11 @@
|
||||
* \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
|
||||
* \brief Digital button board hardware driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_Buttons_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Sec_ModDescription Module Description
|
||||
* \section Sec_Buttons_ModDescription Module Description
|
||||
* Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
|
||||
* It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
|
||||
* actions can be taken.
|
||||
@@ -61,7 +61,7 @@
|
||||
*
|
||||
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.
|
||||
*
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* \section Sec_Buttons_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
|
||||
@@ -48,11 +48,11 @@
|
||||
* \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
|
||||
* \brief Atmel Dataflash storage IC board hardware driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_Dataflash_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Sec_ModDescription Module Description
|
||||
* \section Sec_Dataflash_ModDescription Module Description
|
||||
* Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
|
||||
* for the storage of large amounts of data into the Dataflash's non-volatile memory.
|
||||
*
|
||||
@@ -61,7 +61,7 @@
|
||||
*
|
||||
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.
|
||||
*
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* \section Sec_Dataflash_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
|
||||
@@ -47,11 +47,11 @@
|
||||
* \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
|
||||
* \brief Digital joystick board hardware driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_Joystick_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Sec_ModDescription Module Description
|
||||
* \section Sec_Joystick_ModDescription Module Description
|
||||
* Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
|
||||
* located on many boards.
|
||||
*
|
||||
@@ -60,7 +60,7 @@
|
||||
*
|
||||
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.
|
||||
*
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* \section Sec_Joystick_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
|
||||
@@ -47,11 +47,11 @@
|
||||
* \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
|
||||
* \brief LED board hardware driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_LEDs_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Sec_ModDescription Module Description
|
||||
* \section Sec_LEDs_ModDescription Module Description
|
||||
* Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
|
||||
* provides an interface to configure, test and change the status of all the board LEDs.
|
||||
*
|
||||
@@ -69,7 +69,7 @@
|
||||
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
|
||||
* which contains only stub functions and defines no LEDs.
|
||||
*
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* \section Sec_LEDs_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
|
||||
@@ -38,17 +38,17 @@
|
||||
* \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
|
||||
* \brief NTC Temperature Sensor board hardware driver.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* \section Sec_Temperature_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
* - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>
|
||||
*
|
||||
* \section Sec_ModDescription Module Description
|
||||
* \section Sec_Temperature_ModDescription Module Description
|
||||
* Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
|
||||
* on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
|
||||
* current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
|
||||
* official Atmel USB AVR boards, as each sensor has different characteristics.
|
||||
*
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* \section Sec_Temperature_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
@@ -56,7 +56,7 @@
|
||||
* // Initialize the ADC and board temperature sensor drivers before first use
|
||||
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
|
||||
* Temperature_Init();
|
||||
*
|
||||
*
|
||||
* // Display converted temperature in degrees Celsius
|
||||
* printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature());
|
||||
* \endcode
|
||||
@@ -75,7 +75,7 @@
|
||||
(BOARD == BOARD_STK526) || (BOARD == BOARD_EVK527))
|
||||
#define TEMPERATURE_SENSOR_DRIVER_COMPATIBLE
|
||||
#endif
|
||||
|
||||
|
||||
#if !defined(__INCLUDE_FROM_TEMPERATURE_C) && !defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE)
|
||||
#error The selected board does not contain a compatible temperature sensor.
|
||||
#endif
|
||||
@@ -140,7 +140,7 @@
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
|
||||
Reference in New Issue
Block a user