From 2732c959eb0435f5f056fd6b6e191395128ea882 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 22 Mar 2010 16:16:52 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1772 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/readme.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs/readme.txt') 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. -- cgit v1.2.3