diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-22 16:16:52 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-22 16:16:52 +0000 |
| commit | 2732c959eb0435f5f056fd6b6e191395128ea882 (patch) | |
| tree | 8e3b42808009c31c864fcc57281bba80d5b4b381 /docs/readme.txt | |
| parent | 36f96c9fef7b5670dc9ab1c73c928d66b5bf4492 (diff) | |
| download | ChibiOS-2732c959eb0435f5f056fd6b6e191395128ea882.tar.gz ChibiOS-2732c959eb0435f5f056fd6b6e191395128ea882.tar.bz2 ChibiOS-2732c959eb0435f5f056fd6b6e191395128ea882.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1772 35acf78f-673a-0410-8e92-d51de3d6d3f4
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.
|