diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/0.doxygen/example/src/function.c | 12 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/uart/uart.md | 2 |
2 files changed, 7 insertions, 7 deletions
diff --git a/documentation/0.doxygen/example/src/function.c b/documentation/0.doxygen/example/src/function.c index 98b2007dea..96b30f7090 100644 --- a/documentation/0.doxygen/example/src/function.c +++ b/documentation/0.doxygen/example/src/function.c @@ -33,10 +33,12 @@ * * To documenting for functions, a comment block before the function * declaraion/definition is recommended to describe the general information - * of the function. In the comment block, a `@brief` is required, a `@return` - * is also required no matter if the function return values or not. `@param` is - * required if any, and if it is provided, direction [in]/[out]/[in,out] should - * be provide together. Other commands (such as `@note`) are optional. + * of the function. In the comment block, a `@brief` is required. A `@return` + * is also required if the function is intended to return a value, otherwise + * if the function is implemented with a void return type, `@return` is not + * required. `@param` is required if any, and if it is provided, + * direction [in]/[out]/[in,out] should be provide together. Other commands + * (such as `@note`) are optional. * * If you feel that the description of `@brief` is not enough, you * can add a detailed description part, which is also optional. @@ -72,8 +74,6 @@ * * @param[in] b Description of param b * - * @return void - * * @note This is a note for this structure, blah blah blah... */ void doxygen_example_func_foo(int a, int b) diff --git a/documentation/6.components/device-driver/uart/uart.md b/documentation/6.components/device-driver/uart/uart.md index 8f1784ced3..0a87440b71 100644 --- a/documentation/6.components/device-driver/uart/uart.md +++ b/documentation/6.components/device-driver/uart/uart.md @@ -86,7 +86,7 @@ There are three modes of uart data receiving and sending: interrupt mode, pollin The DMA (Direct Memory Access) transfer mode does not require the CPU to directly control the transfer, and does not have the process of reserving the scene and restoring the scene as they have in the interrupt processing mode. The DMA controller opens a path for directly transferring data to the RAM and the I/O device, which saves CPU resources to do other things. Using DMA transfer can continuously acquire or send a piece of information without taking up interrupts or delays, which is useful when communication is frequent or when large pieces of information are to be transmitted. ->RT_DEVICE_FLAG_STREAM: Stream mode is used to output a string to the serial terminal: when the output character is `"\n"` (corresponding to the hexadecimal value 0x0A), a ``\r"` is automatically output in front (corresponding to hexadecimal value is 0x0D). +> RT_DEVICE_FLAG_STREAM: Stream mode is used to output a string to the serial terminal: when the output character is `"\n"` (corresponding to the hexadecimal value 0x0A), a `"\r"` is automatically output in front (corresponding to hexadecimal value is 0x0D). The stream mode `RT_DEVICE_FLAG_STREAM` can be used with the receive and send mode parameter with the "|" logic. |