1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

doc: periph: various fixes and cleanup

- unify file/module @brief
- distinct @file section more visibly in source
- provide missing @brief's
- move module details/notes from file to module sections
- provide missing macro definition for building
This commit is contained in:
Ludwig Ortmann 2014-12-04 10:03:15 +01:00
parent 9379c7330d
commit da43a5e7a4
10 changed files with 29 additions and 23 deletions

View File

@ -1980,6 +1980,7 @@ INCLUDE_FILE_PATTERNS =
PREDEFINED = __attribute__(x)= \ PREDEFINED = __attribute__(x)= \
ADC_NUMOF \ ADC_NUMOF \
CPUID_ID_LEN \ CPUID_ID_LEN \
DAC_NUMOF \
GPIO_NUMOF \ GPIO_NUMOF \
I2C_NUMOF \ I2C_NUMOF \
PWM_NUMOF \ PWM_NUMOF \

View File

@ -9,10 +9,13 @@
/** /**
* @defgroup driver_periph_cpuid CPUID * @defgroup driver_periph_cpuid CPUID
* @ingroup driver_periph * @ingroup driver_periph
* @{ * @brief Low-level CPU ID peripheral driver
* *
* Provides access the CPU's serial number
*
* @{
* @file * @file
* @brief Provides access the CPU's serial number * @brief Low-level CPUID peripheral driver interface definitions
* *
* @author Martine Lenders <mlenders@inf.fu-berlin.de> * @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/ */

View File

@ -10,8 +10,8 @@
* @defgroup driver_periph_dac DAC * @defgroup driver_periph_dac DAC
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level DAC peripheral driver * @brief Low-level DAC peripheral driver
* @{
* *
* @{
* @file * @file
* @brief Low-level DAC peripheral driver interface definitions * @brief Low-level DAC peripheral driver interface definitions
* *
@ -28,15 +28,15 @@
extern "C" { extern "C" {
#endif #endif
/* guard file in case no ADC device is defined */ /* guard file in case no DAC device is defined */
#if DAC_NUMOF #if DAC_NUMOF
/** /**
* @brief Definition avialable DAC devices * @brief Definition avialable DAC devices
* *
* Each DAC device is based on a hardware DAC which can have one or more * Each DAC device is based on a hardware DAC which can have one or more
* independet channels. * independet channels.
*/ */
typedef enum { typedef enum {
#if DAC_0_EN #if DAC_0_EN
DAC_0 = 0, /**< DAC device 0 */ DAC_0 = 0, /**< DAC device 0 */

View File

@ -10,8 +10,8 @@
* @defgroup driver_periph_gpio GPIO * @defgroup driver_periph_gpio GPIO
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level GPIO peripheral driver * @brief Low-level GPIO peripheral driver
* @{
* *
* @{
* @file * @file
* @brief Low-level GPIO peripheral driver interface definitions * @brief Low-level GPIO peripheral driver interface definitions
* *

View File

@ -10,8 +10,8 @@
* @defgroup driver_periph_i2c I2C * @defgroup driver_periph_i2c I2C
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level I2C peripheral driver * @brief Low-level I2C peripheral driver
* @{
* *
* @{
* @file * @file
* @brief Low-level I2C peripheral driver interface definition * @brief Low-level I2C peripheral driver interface definition
* *

View File

@ -10,8 +10,8 @@
* @defgroup driver_periph_pwm PWM * @defgroup driver_periph_pwm PWM
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level PWM peripheral driver * @brief Low-level PWM peripheral driver
* @{
* *
* @{
* @file * @file
* @brief Low-level PWM peripheral driver interface definitions * @brief Low-level PWM peripheral driver interface definitions
* *

View File

@ -9,12 +9,9 @@
/** /**
* @defgroup driver_periph_random Random * @defgroup driver_periph_random Random
* @ingroup driver_periph * @ingroup driver_periph
* @{ * @brief Low-level (pseudo) random number generator driver
* *
* @file * The quality of the random data read from this interface is highly
* @brief (Pseudo) random number generator low-level driver interface
*
* NOTE: The quality of the random data read from this interface is highly
* dependent on hardware dependent implementation. Most platforms utilize a * dependent on hardware dependent implementation. Most platforms utilize a
* hardware (Pseudo) Random Number Generator. The quality of the generated * hardware (Pseudo) Random Number Generator. The quality of the generated
* random data can be however very different. * random data can be however very different.
@ -22,6 +19,10 @@
* @note REFER TO YOUR PLATFORMS IMPLEMENTATION ABOUT INFORMATION ABOUT THE * @note REFER TO YOUR PLATFORMS IMPLEMENTATION ABOUT INFORMATION ABOUT THE
* QUALITY OF RANDOMNES! * QUALITY OF RANDOMNES!
* *
* @{
* @file
* @brief Low-level random peripheral driver interface definitions
*
* @author Christian Mehlis <mehlis@inf.fu-berlin.de> * @author Christian Mehlis <mehlis@inf.fu-berlin.de>
*/ */

View File

@ -10,8 +10,8 @@
* @defgroup driver_periph_rtc RTC * @defgroup driver_periph_rtc RTC
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level RTC (Real Time Clock) peripheral driver * @brief Low-level RTC (Real Time Clock) peripheral driver
* @{
* *
* @{
* @file * @file
* @brief Low-level RTC peripheral driver interface definitions * @brief Low-level RTC peripheral driver interface definitions
* *

View File

@ -9,8 +9,9 @@
/** /**
* @defgroup driver_periph_rtt RTT * @defgroup driver_periph_rtt RTT
* @ingroup driver_periph * @ingroup driver_periph
* @{ * @brief Low-level RTT (Real Time Timer) peripheral driver
* *
* @{
* @file * @file
* @brief Low-level RTT (Real Time Timer) peripheral driver interface * @brief Low-level RTT (Real Time Timer) peripheral driver interface
* definitions * definitions

View File

@ -10,15 +10,15 @@
* @defgroup driver_periph_spi SPI * @defgroup driver_periph_spi SPI
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level SPI peripheral driver * @brief Low-level SPI peripheral driver
* @{
*
* @file
* @brief Low-level SPI peripheral driver interface definitions
* *
* The current design of this interface targets implementations that use the SPI in blocking mode. * The current design of this interface targets implementations that use the SPI in blocking mode.
* *
* TODO: add means for asynchronous SPI usage * TODO: add means for asynchronous SPI usage
* *
* @{
* @file
* @brief Low-level SPI peripheral driver interface definitions
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */