From 2891f7d645c4be187ac96ee4011207531d25c34a Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Mon, 4 Oct 2010 17:16:18 +0000
Subject: 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
---
 os/hal/platforms/AT91SAM7/pal_lld.c | 32 ++++++++++++++++++--------------
 1 file changed, 18 insertions(+), 14 deletions(-)

(limited to 'os/hal/platforms/AT91SAM7/pal_lld.c')

diff --git a/os/hal/platforms/AT91SAM7/pal_lld.c b/os/hal/platforms/AT91SAM7/pal_lld.c
index 3ea061f07..6545be0e6 100644
--- a/os/hal/platforms/AT91SAM7/pal_lld.c
+++ b/os/hal/platforms/AT91SAM7/pal_lld.c
@@ -18,8 +18,9 @@
 */
 
 /**
- * @file AT91SAM7/pal_lld.c
- * @brief AT91SAM7 PIO low level driver code.
+ * @file    AT91SAM7/pal_lld.c
+ * @brief   AT91SAM7 PIO low level driver code.
+ *
  * @addtogroup AT91SAM7_PAL
  * @{
  */
@@ -50,10 +51,12 @@
 /*===========================================================================*/
 
 /**
- * @brief AT91SAM7 I/O ports configuration.
+ * @brief   AT91SAM7 I/O ports configuration.
  * @details PIO registers initialization.
  *
- * @param[in] config the AT91SAM7 ports configuration
+ * @param[in] config    the AT91SAM7 ports configuration
+ *
+ * @notapi
  */
 void _pal_lld_init(const PALConfig *config) {
 
@@ -99,20 +102,21 @@ void _pal_lld_init(const PALConfig *config) {
 }
 
 /**
- * @brief Pads mode setup.
+ * @brief   Pads mode setup.
  * @details This function programs a pads group belonging to the same port
  *          with the specified mode.
+ * @note    This function is not meant to be invoked directly from the
+ *          application code.
+ * @note    @p PAL_MODE_RESET is implemented as input with pull-up.
+ * @note    @p PAL_MODE_UNCONNECTED is implemented as push pull output with
+ *          high state.
+ * @note    @p PAL_MODE_OUTPUT_OPENDRAIN also enables the pull-up resistor.
  *
- * @param[in] port the port identifier
- * @param[in] mask the group mask
- * @param[in] mode the mode
+ * @param[in] port      the port identifier
+ * @param[in] mask      the group mask
+ * @param[in] mode      the mode
  *
- * @note This function is not meant to be invoked directly by the application
- *       code.
- * @note @p PAL_MODE_RESET is implemented as input with pull-up.
- * @note @p PAL_MODE_UNCONNECTED is implemented as push pull output with high
- *       state.
- * @note @p PAL_MODE_OUTPUT_OPENDRAIN also enables the pull-up resistor.
+ * @notapi
  */
 void _pal_lld_setgroupmode(ioportid_t port,
                            ioportmask_t mask,
-- 
cgit v1.2.3