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

@@ -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

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
  */

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
  */

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
 }

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
  */

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
  * @{

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

readme.txt

@@ -78,6 +78,7 @@
   no more required to specify ADC_CR2_EXTSEL_SWSTART and ADC_CR2_CONT
   in the CR2 register configuration. Also reordered the start sequence
   in order to allows a longer stabilization time for the ADC.
+- Documentation improvements.
 
 *** 2.1.5 ***
 - FIX: Fixed references to non-existing SSP1 device in LPC13xx SPI device