diff options
Diffstat (limited to 'docs/readme.txt')
| -rw-r--r-- | docs/readme.txt | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/readme.txt b/docs/readme.txt index b8ee45e2a..17d5b9136 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -24,12 +24,11 @@ Build procedure: - Normal paragraphs, return rescriptions and notes must start with a capital
letter and must be terminated with a dot.
- Multiple return values should be listed using the @retval command.
-- AUTOBRIEF is enabled but deprecated, gradually convert to the use of explicit
- @brief command.
+- Parameters direction must be specified.
Examples:
@note This is a note.
@retval RDY_OK is a possible return value.
@return The pointer to the created thread is returned.
-@param n the number of bytes to be written
-@param n the number of bytes to be written. This value can be zero.
+@param[in] n the number of bytes to be written
+@param[in] n the number of bytes to be written. This value can be zero.
|