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/at91sam7_mii.c | 35 ++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 13 deletions(-)

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

diff --git a/os/hal/platforms/AT91SAM7/at91sam7_mii.c b/os/hal/platforms/AT91SAM7/at91sam7_mii.c
index 8a79082c5..2f1665847 100644
--- a/os/hal/platforms/AT91SAM7/at91sam7_mii.c
+++ b/os/hal/platforms/AT91SAM7/at91sam7_mii.c
@@ -18,8 +18,9 @@
 */
 
 /**
- * @file AT91SAM7/at91sam7_mii.c
- * @brief AT91SAM7 low level MII driver code.
+ * @file    AT91SAM7/at91sam7_mii.c
+ * @brief   AT91SAM7 low level MII driver code.
+ *
  * @addtogroup AT91SAM7_MII
  * @{
  */
@@ -51,16 +52,20 @@
 /*===========================================================================*/
 
 /**
- * @brief Low level MII driver initialization.
+ * @brief   Low level MII driver initialization.
+ *
+ * @notapi
  */
 void miiInit(void) {
 
 }
 
 /**
- * @brief Resets a PHY device.
+ * @brief   Resets a PHY device.
+ *
+ * @param[in] macp      pointer to the @p MACDriver object
  *
- * @param[in] macp pointer to the @p MACDriver object
+ * @notapi
  */
 void miiReset(MACDriver *macp) {
 
@@ -94,11 +99,13 @@ void miiReset(MACDriver *macp) {
 }
 
 /**
- * @brief Reads a PHY register through the MII interface.
+ * @brief   Reads a PHY register through the MII interface.
  *
- * @param[in] macp pointer to the @p MACDriver object
- * @param addr the register address
- * @return The register value.
+ * @param[in] macp      pointer to the @p MACDriver object
+ * @param[in] addr      the register address
+ * @return              The register value.
+ *
+ * @notapi
  */
 phyreg_t miiGet(MACDriver *macp, phyaddr_t addr) {
 
@@ -114,11 +121,13 @@ phyreg_t miiGet(MACDriver *macp, phyaddr_t addr) {
 }
 
 /**
- * @brief Writes a PHY register through the MII interface.
+ * @brief   Writes a PHY register through the MII interface.
+ *
+ * @param[in] macp      pointer to the @p MACDriver object
+ * @param[in] addr      the register address
+ * @param[in] value     the new register value
  *
- * @param[in] macp pointer to the @p MACDriver object
- * @param addr the register address
- * @param value the new register value
+ * @notapi
  */
 void miiPut(MACDriver *macp, phyaddr_t addr, phyreg_t value) {
 
-- 
cgit v1.2.3