From 7aa43aee7029b232c558174bcbdf90e8fbebd57b Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 18 Dec 2010 08:31:56 +0000 Subject: Documentation improvements. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2490 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/include/pal.h | 2 ++ os/hal/src/adc.c | 2 ++ os/hal/src/can.c | 2 ++ os/hal/src/hal.c | 22 ++++++++++++---------- os/hal/src/i2c.c | 2 ++ os/hal/src/mac.c | 2 ++ os/hal/src/mmc_spi.c | 2 ++ os/hal/src/pwm.c | 2 ++ os/hal/src/serial.c | 2 ++ os/hal/src/spi.c | 2 ++ os/hal/src/uart.c | 2 ++ os/hal/templates/meta/driver.c | 2 ++ 12 files changed, 34 insertions(+), 10 deletions(-) (limited to 'os') diff --git a/os/hal/include/pal.h b/os/hal/include/pal.h index 211a2538f..6f3c4a7e5 100644 --- a/os/hal/include/pal.h +++ b/os/hal/include/pal.h @@ -185,6 +185,8 @@ typedef struct { /** * @brief PAL subsystem initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @param[in] config pointer to an architecture specific configuration * structure. This structure is defined in the low level driver diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c index 2af890b63..e057ea425 100644 --- a/os/hal/src/adc.c +++ b/os/hal/src/adc.c @@ -48,6 +48,8 @@ /** * @brief ADC Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/can.c b/os/hal/src/can.c index 59a7b5dbf..f389380ea 100644 --- a/os/hal/src/can.c +++ b/os/hal/src/can.c @@ -48,6 +48,8 @@ /** * @brief CAN Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/hal.c b/os/hal/src/hal.c index 4cf145059..beff1c8ad 100644 --- a/os/hal/src/hal.c +++ b/os/hal/src/hal.c @@ -46,6 +46,8 @@ /** * @brief HAL initialization. + * @details This function invokes the low level initialization code then + * initializes all the drivers enabled in the HAL. * * @init */ @@ -53,34 +55,34 @@ void halInit(void) { hal_lld_init(); -#if HAL_USE_PAL +#if HAL_USE_PAL || defined(__DOXYGEN__) palInit(&pal_default_config); #endif -#if HAL_USE_ADC +#if HAL_USE_ADC || defined(__DOXYGEN__) adcInit(); #endif -#if HAL_USE_CAN +#if HAL_USE_CAN || defined(__DOXYGEN__) canInit(); #endif -#if HAL_USE_I2C +#if HAL_USE_I2C || defined(__DOXYGEN__) i2cInit(); #endif -#if HAL_USE_MAC +#if HAL_USE_MAC || defined(__DOXYGEN__) macInit(); #endif -#if HAL_USE_PWM +#if HAL_USE_PWM || defined(__DOXYGEN__) pwmInit(); #endif -#if HAL_USE_SERIAL +#if HAL_USE_SERIAL || defined(__DOXYGEN__) sdInit(); #endif -#if HAL_USE_SPI +#if HAL_USE_SPI || defined(__DOXYGEN__) spiInit(); #endif -#if HAL_USE_MMC_SPI +#if HAL_USE_MMC_SPI || defined(__DOXYGEN__) mmcInit(); #endif -#if HAL_USE_UART +#if HAL_USE_UART || defined(__DOXYGEN__) uartInit(); #endif } diff --git a/os/hal/src/i2c.c b/os/hal/src/i2c.c index b432fa89f..429d4b521 100644 --- a/os/hal/src/i2c.c +++ b/os/hal/src/i2c.c @@ -48,6 +48,8 @@ /** * @brief I2C Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/mac.c b/os/hal/src/mac.c index bed07fbbb..89d6a689b 100644 --- a/os/hal/src/mac.c +++ b/os/hal/src/mac.c @@ -20,6 +20,8 @@ /** * @file mac.c * @brief MAC Driver code. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @addtogroup MAC * @{ diff --git a/os/hal/src/mmc_spi.c b/os/hal/src/mmc_spi.c index 813ed9de1..f98f3f435 100644 --- a/os/hal/src/mmc_spi.c +++ b/os/hal/src/mmc_spi.c @@ -194,6 +194,8 @@ static void sync(MMCDriver *mmcp) { /** * @brief MMC over SPI driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c index ec5bd65be..8a009e3b5 100644 --- a/os/hal/src/pwm.c +++ b/os/hal/src/pwm.c @@ -48,6 +48,8 @@ /** * @brief PWM Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/serial.c b/os/hal/src/serial.c index 8ec75d000..166ca83d3 100644 --- a/os/hal/src/serial.c +++ b/os/hal/src/serial.c @@ -99,6 +99,8 @@ static const struct SerialDriverVMT vmt = { /** * @brief Serial Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/spi.c b/os/hal/src/spi.c index d1102cc6e..966db3de5 100644 --- a/os/hal/src/spi.c +++ b/os/hal/src/spi.c @@ -48,6 +48,8 @@ /** * @brief SPI Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/src/uart.c b/os/hal/src/uart.c index eb771bb7b..4bed0d71b 100644 --- a/os/hal/src/uart.c +++ b/os/hal/src/uart.c @@ -48,6 +48,8 @@ /** * @brief UART Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c index 234f70e09..81424d115 100644 --- a/os/hal/templates/meta/driver.c +++ b/os/hal/templates/meta/driver.c @@ -48,6 +48,8 @@ /** * @brief XXX Driver initialization. + * @note This function is implicitly invoked by @p halInit(), there is + * no need to explicitly initialize the driver. * * @init */ -- cgit v1.2.3