From 24cb881726f09c6bccba471b40bde76dc27036c7 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Tue, 4 Jan 2011 15:08:29 +0000
Subject: Documentation related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2580 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/hal/platforms/STM32/uart_lld.c | 2 +-
 os/hal/src/adc.c                  | 2 +-
 os/hal/src/can.c                  | 2 +-
 os/hal/src/i2c.c                  | 2 +-
 os/hal/src/mac.c                  | 2 +-
 os/hal/src/mmc_spi.c              | 2 +-
 os/hal/src/pwm.c                  | 2 +-
 os/hal/src/spi.c                  | 2 +-
 os/hal/src/uart.c                 | 4 ++--
 os/hal/templates/meta/driver.c    | 2 +-
 os/hal/templates/uart_lld.c       | 2 +-
 11 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'os/hal')

diff --git a/os/hal/platforms/STM32/uart_lld.c b/os/hal/platforms/STM32/uart_lld.c
index 2b30ce6a3..5d5f323f1 100644
--- a/os/hal/platforms/STM32/uart_lld.c
+++ b/os/hal/platforms/STM32/uart_lld.c
@@ -629,7 +629,7 @@ size_t uart_lld_stop_send(UARTDriver *uartp) {
  *
  * @param[in] uartp     pointer to the @p UARTDriver object
  * @param[in] n         number of data frames to send
- * @param[in] rxbuf     the pointer to the receive buffer
+ * @param[out] rxbuf    the pointer to the receive buffer
  *
  * @notapi
  */
diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c
index c5ac7534a..25cbfe750 100644
--- a/os/hal/src/adc.c
+++ b/os/hal/src/adc.c
@@ -61,7 +61,7 @@ void adcInit(void) {
 /**
  * @brief   Initializes the standard part of a @p ADCDriver structure.
  *
- * @param[in] adcp      pointer to the @p ADCDriver object
+ * @param[out] adcp     pointer to the @p ADCDriver object
  *
  * @init
  */
diff --git a/os/hal/src/can.c b/os/hal/src/can.c
index 22f816e73..d63cbfd8a 100644
--- a/os/hal/src/can.c
+++ b/os/hal/src/can.c
@@ -61,7 +61,7 @@ void canInit(void) {
 /**
  * @brief   Initializes the standard part of a @p CANDriver structure.
  *
- * @param[in] canp      pointer to the @p CANDriver object
+ * @param[out] canp     pointer to the @p CANDriver object
  *
  * @init
  */
diff --git a/os/hal/src/i2c.c b/os/hal/src/i2c.c
index 429d4b521..2b5971b6f 100644
--- a/os/hal/src/i2c.c
+++ b/os/hal/src/i2c.c
@@ -61,7 +61,7 @@ void i2cInit(void) {
 /**
  * @brief   Initializes the standard part of a @p I2CDriver structure.
  *
- * @param[in] i2cp      pointer to the @p I2CDriver object
+ * @param[out] i2cp     pointer to the @p I2CDriver object
  *
  * @init
  */
diff --git a/os/hal/src/mac.c b/os/hal/src/mac.c
index 89d6a689b..48656a8a3 100644
--- a/os/hal/src/mac.c
+++ b/os/hal/src/mac.c
@@ -65,7 +65,7 @@ void macInit(void) {
 /**
  * @brief   Initialize the standard part of a @p MACDriver structure.
  *
- * @param[in] macp      pointer to the @p MACDriver object
+ * @param[out] macp     pointer to the @p MACDriver object
  *
  * @init
  */
diff --git a/os/hal/src/mmc_spi.c b/os/hal/src/mmc_spi.c
index 1004c26c2..1b2d930c5 100644
--- a/os/hal/src/mmc_spi.c
+++ b/os/hal/src/mmc_spi.c
@@ -206,7 +206,7 @@ void mmcInit(void) {
 /**
  * @brief   Initializes an instance.
  *
- * @param[in] mmcp          pointer to the @p MMCDriver object
+ * @param[out] mmcp         pointer to the @p MMCDriver object
  * @param[in] spip          pointer to the SPI driver to be used as interface
  * @param[in] lscfg         low speed configuration for the SPI driver
  * @param[in] hscfg         high speed configuration for the SPI driver
diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c
index 8a009e3b5..cf619e508 100644
--- a/os/hal/src/pwm.c
+++ b/os/hal/src/pwm.c
@@ -61,7 +61,7 @@ void pwmInit(void) {
 /**
  * @brief   Initializes the standard part of a @p PWMDriver structure.
  *
- * @param[in] pwmp      pointer to a @p PWMDriver object
+ * @param[out] pwmp     pointer to a @p PWMDriver object
  *
  * @init
  */
diff --git a/os/hal/src/spi.c b/os/hal/src/spi.c
index 966db3de5..e99126b9e 100644
--- a/os/hal/src/spi.c
+++ b/os/hal/src/spi.c
@@ -61,7 +61,7 @@ void spiInit(void) {
 /**
  * @brief   Initializes the standard part of a @p SPIDriver structure.
  *
- * @param[in] spip      pointer to the @p SPIDriver object
+ * @param[out] spip     pointer to the @p SPIDriver object
  *
  * @init
  */
diff --git a/os/hal/src/uart.c b/os/hal/src/uart.c
index 4bed0d71b..4a21e907f 100644
--- a/os/hal/src/uart.c
+++ b/os/hal/src/uart.c
@@ -61,7 +61,7 @@ void uartInit(void) {
 /**
  * @brief   Initializes the standard part of a @p UARTDriver structure.
  *
- * @param[in] uartp     pointer to the @p UARTDriver object
+ * @param[out] uartp    pointer to the @p UARTDriver object
  *
  * @init
  */
@@ -273,7 +273,7 @@ void uartStartReceive(UARTDriver *uartp, size_t n, void *rxbuf) {
  *
  * @param[in] uartp     pointer to the @p UARTDriver object
  * @param[in] n         number of data frames to send
- * @param[in] rxbuf     the pointer to the receive buffer
+ * @param[out] rxbuf    the pointer to the receive buffer
  *
  * @iclass
  */
diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c
index 81424d115..f75c5d380 100644
--- a/os/hal/templates/meta/driver.c
+++ b/os/hal/templates/meta/driver.c
@@ -61,7 +61,7 @@ void xxxInit(void) {
 /**
  * @brief   Initializes the standard part of a @p XXXDriver structure.
  *
- * @param[in] xxxp      pointer to the @p XXXDriver object
+ * @param[out] xxxp     pointer to the @p XXXDriver object
  *
  * @init
  */
diff --git a/os/hal/templates/uart_lld.c b/os/hal/templates/uart_lld.c
index 264446369..ab0abeb55 100644
--- a/os/hal/templates/uart_lld.c
+++ b/os/hal/templates/uart_lld.c
@@ -122,7 +122,7 @@ size_t uart_lld_stop_send(UARTDriver *uartp) {
  *
  * @param[in] uartp     pointer to the @p UARTDriver object
  * @param[in] n         number of data frames to send
- * @param[in] rxbuf     the pointer to the receive buffer
+ * @param[out] rxbuf    the pointer to the receive buffer
  *
  * @notapi
  */
-- 
cgit v1.2.3