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, 11 deletions

diff --git a/os/hal/platforms/LPC13xx/pal_lld.c b/os/hal/platforms/LPC13xx/pal_lld.c
index f63650c0f..f1e766c4d 100644
--- a/os/hal/platforms/LPC13xx/pal_lld.c
+++ b/os/hal/platforms/LPC13xx/pal_lld.c
@@ -50,10 +50,12 @@
 /* Driver exported functions.                                                */

 /*===========================================================================*/

 /**

- * @brief LPC13xx I/O ports configuration.

+ * @brief   LPC13xx I/O ports configuration.

  * @details GPIO unit registers initialization.

  *

  * @param[in] config the LPC13xx ports configuration

+ *

+ * @notapi

  */

 void _pal_lld_init(const PALConfig *config) {

 

@@ -68,20 +70,19 @@ 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    @p PAL_MODE_UNCONNECTED is implemented as push pull output with

+ *          high state.

+ * @note    This function does not alter the @p PINSELx registers. Alternate

+ *          functions setup must be handled by device-specific code.

  *

- * @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_UNCONNECTED is implemented as push pull output with high

- *       state.

- * @note This function does not alter the @p PINSELx registers. Alternate

- *       functions setup must be handled by device-specific code.

+ * @notapi

  */

 void _pal_lld_setgroupmode(ioportid_t port,

                            ioportmask_t mask,