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

@@ -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
  */

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
  */

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
  */

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
  */

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
  */

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

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
  */

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
  */

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
  */

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
  */

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
  */

readme.txt

@@ -90,7 +90,8 @@
   files and saved some space.
 - CHANGE: Queues callbacks now have as parameter a pointer to the queue,
   there were no parameters previously.
- 
+- Documentation related fixes.
+
 *** 2.1.6 ***
 - FIX: Fixed error in sdPutTimeout() macro (bug 3138763)(backported in 2.0.9).
 - NEW: New ARM Cortex-Mx port for IAR compiler (probably will not be

todo.txt

@@ -68,6 +68,9 @@ X Add an USB abstract device driver class.
 X USB driver implementation for STM32F103/STM32F102.
 X Add a Serial over USB generic device driver implementing a USB Communication
   Device Class and offering a Serial-like interface to the applications.
+- Change the serial drivers to have a single event source instead of three.
+  Add Rx and Tx to the existing flags mechanism. Move up the flags handling in
+  the superclass.
 X Except for the above, bug fixing only until the 2.2.0 release.
 
 Within 2.3.x (hopefully)