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, 12 insertions, 6 deletions

diff --git a/os/hal/platforms/AT91SAM7/hal_lld.c b/os/hal/platforms/AT91SAM7/hal_lld.c
index 370b7cad5..4f2845411 100644
--- a/os/hal/platforms/AT91SAM7/hal_lld.c
+++ b/os/hal/platforms/AT91SAM7/hal_lld.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file AT91SAM7/hal_lld.c

- * @brief AT91SAM7 HAL subsystem low level driver source.

+ * @file    AT91SAM7/hal_lld.c

+ * @brief   AT91SAM7 HAL subsystem low level driver source.

+ *

  * @addtogroup AT91SAM7_HAL

  * @{

  */

@@ -36,7 +37,7 @@
 /*===========================================================================*/

 

 /**

- * @brief PAL setup.

+ * @brief   PAL setup.

  * @details Digital I/O ports static configuration as defined in @p board.h.

  */

 const PALConfig pal_default_config =

@@ -72,7 +73,9 @@ static CH_IRQ_HANDLER(spurious_handler) {
 /*===========================================================================*/

 

 /**

- * @brief Low level HAL driver initialization.

+ * @brief   Low level HAL driver initialization.

+ *

+ * @notapi

  */

 void hal_lld_init(void) {

   unsigned i;

@@ -93,8 +96,11 @@ void hal_lld_init(void) {
 }

 

 /**

- * @brief AT91SAM7 clocks and PLL initialization.

- * @note All the involved constants come from the file @p board.h.

+ * @brief   AT91SAM7 clocks and PLL initialization.

+ * @note    All the involved constants come from the file @p board.h.

+ * @note    This function must be invoked only after the system reset.

+ *

+ * @special

  */

 void at91sam7_clock_init(void) {