From 1d23eb296156769cff3e41bd7026db1cd2538664 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Fri, 17 Oct 2008 18:33:35 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@474 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/readme.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/readme.txt (limited to 'docs/readme.txt') diff --git a/docs/readme.txt b/docs/readme.txt new file mode 100644 index 000000000..730d20072 --- /dev/null +++ b/docs/readme.txt @@ -0,0 +1,35 @@ +*** Documentation access *** + +Open ./docs/index.html to open the start page or ./docs/html/index.html in +order to access directly the doxigen documentation. + +*** Documentation rebuild procedure *** + +The following software must be installed: +- Doxigen 1.5.7.1 or later. +- Graphviz 2.21 or later. The ./bin directory must be specified in the path in + order to make Graphviz accessible by doxigen. + +Build procedure: +- Run Doxiwizard. +- Load ./docs/Doxifile from Doxiwizard. +- Start. + +*** Doxygen usage rules *** +- The JavaDoc style is recommended (@ instad of \, /** instead of /*!). +- Params descriptions must not begin with a capital letter and must not be + terminated with a dot unless it is composed of multiple paragraphs. +- Retvals descriptions must not begin with a capital letter but must be + terminated by a dot. +- 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. + +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. -- cgit v1.2.3