Documentation improvements, fixed a small error in the STM32 serial driver.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2234 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 20 insertions, 0 deletions

diff --git a/os/hal/hal.dox b/os/hal/hal.dox
index 591666580..7b51039ad 100644
--- a/os/hal/hal.dox
+++ b/os/hal/hal.dox
@@ -113,6 +113,8 @@
  * in order to support specific features but, of course, the use of such

  * interfaces would not be portable. Such interfaces shall be marked with

  * the architecture name inside the function names.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_PAL option

+ *          must be enabled in @p halconf.h.

  *

  * @section pal_1 Implementation Rules

  * In implementing an @ref PAL_LLD there are some rules/behaviors that

@@ -169,6 +171,8 @@
  * events.<br>

  * The  module also contains functions that make the implementation of the

  * interrupt service routines much easier.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_SERIAL option

+ *          must be enabled in @p halconf.h.

  *

  * @ingroup IO

  */

@@ -187,6 +191,8 @@
  * @defgroup I2C I2C Driver

  * @brief Generic I2C Driver.

  * @details This module implements a generic I2C driver.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_I2C option

+ *          must be enabled in @p halconf.h.

  *

  * @section i2c_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -218,6 +224,8 @@
  * @defgroup SPI SPI Driver

  * @brief Generic SPI Driver.

  * @details This module implements a generic SPI driver.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_SPI option

+ *          must be enabled in @p halconf.h.

  *

  * @section spi_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -293,6 +301,8 @@
  * @defgroup ADC ADC Driver

  * @brief Generic ADC Driver.

  * @details This module implements a generic ADC driver.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_ADC option

+ *          must be enabled in @p halconf.h.

  *

  * @section adc_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -375,6 +385,8 @@
  * @defgroup CAN CAN Driver

  * @brief Generic CAN Driver.

  * @details This module implements a generic ADC driver.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_CAN option

+ *          must be enabled in @p halconf.h.

  *

  * @section can_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -445,6 +457,8 @@
  * @defgroup PWM PWM Driver

  * @brief Generic PWM Driver.

  * @details This module implements a generic PWM driver.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_PWM option

+ *          must be enabled in @p halconf.h.

  *

  * @section pwm_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -485,6 +499,8 @@
  * @brief Generic MAC driver.

  * @details This module implements a generic interface for MAC (Media

  *          Access Control) drivers, as example Ethernet controllers.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_MAC option

+ *          must be enabled in @p halconf.h.

  *

  * @ingroup IO

  */

@@ -504,6 +520,8 @@
  * @brief Generic MMC driver.

  * @details This module implements a portable MMC driver that uses a SPI

  *          driver as physical layer.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_MMC_SPI option

+ *          must be enabled in @p halconf.h.

  *

  * @section mmc_spi_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver

@@ -623,6 +641,8 @@
  * .

  * If your application requires a synchronoyus buffered driver then the

  * @ref SERIAL should be used instead.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_UART option

+ *          must be enabled in @p halconf.h.

  *

  * @section uart_1 Driver State Machine

  * The driver implements a state machine internally, not all the driver