aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/uart.c
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2016-01-03 10:53:23 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2016-01-03 10:53:23 +0000
commit1a7524add7dabf81895a6e6cb170c2b417da4c18 (patch)
tree41e60b63015271c251428ecf59e88f2169c8965c /os/hal/src/uart.c
parent4c12fb1364261b3e8263a558f14fd483f181195c (diff)
downloadChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.tar.gz
ChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.tar.bz2
ChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.zip
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8672 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/src/uart.c')
-rw-r--r--os/hal/src/uart.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/os/hal/src/uart.c b/os/hal/src/uart.c
index f521412ec..96f2bed5f 100644
--- a/os/hal/src/uart.c
+++ b/os/hal/src/uart.c
@@ -320,7 +320,7 @@ size_t uartStopReceive(UARTDriver *uartp) {
* @note Stopping a receive operation also suppresses the receive callbacks.
* @note This function has to be invoked from a lock zone.
*
- * @param[in] uartp pointer to the @p UARTDriver object
+ * @param[in] uartp pointer to the @p UARTDriver object
*
* @return The number of data frames not received by the
* stopped receive operation.
@@ -354,6 +354,7 @@ size_t uartStopReceiveI(UARTDriver *uartp) {
* @param[in,out] np number of data frames to transmit, on exit the number
* of frames actually transmitted
* @param[in] txbuf the pointer to the transmit buffer
+ * @param[in] time operation timeout
* @return The operation status.
* @retval MSG_OK if the operation completed successfully.
* @retval MSG_TIMEOUT if the operation timed out.
@@ -396,6 +397,7 @@ msg_t uartSendTimeout(UARTDriver *uartp, size_t *np,
* @param[in,out] np number of data frames to transmit, on exit the number
* of frames actually transmitted
* @param[in] txbuf the pointer to the transmit buffer
+ * @param[in] time operation timeout
* @return The operation status.
* @retval MSG_OK if the operation completed successfully.
* @retval MSG_TIMEOUT if the operation timed out.