Added shortcut to the web documentation.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2233 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 2 insertions, 20 deletions

diff --git a/docs/readme.txt b/docs/readme.txt
index 17d5b9136..e89c7161d 100644
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -3,10 +3,10 @@
 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 ***

+*** Documentation build procedure ***

 

 The following software must be installed:

-- Doxygen 1.5.7.1 or later.

+- Doxygen 1.6.3 or later.

 - Graphviz 2.21 or later. The ./bin directory must be specified in the path in

   order to make Graphviz accessible by Doxygen.

 

@@ -14,21 +14,3 @@ Build procedure:
 - Run Doxywizard.

 - Load ./docs/Doxyfile from Doxywizard.

 - 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.

-- 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[in] n the number of bytes to be written

-@param[in] n the number of bytes to be written. This value can be zero.