ChibiOS

History

gdisirio ae942d4ba5 git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2335 35acf78f-673a-0410-8e92-d51de3d6d3f4		2010-11-06 11:34:18 +00:00
..
html	Documentation improvements.	2009-03-02 15:42:19 +00:00
reports	git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2335 35acf78f-673a-0410-8e92-d51de3d6d3f4	2010-11-06 11:34:18 +00:00
rsc	Added shortcut to the web documentation.	2010-10-03 13:45:52 +00:00
src	Removed redundant articles in the generated documentation.	2010-10-03 13:20:13 +00:00
Doxyfile	New version numbers, fixed bug 3099701.	2010-10-31 08:34:16 +00:00
index.html	Fixes to the documentation, swapped the values of constants TIME_INFINITE and TIME_IMMEDIATE (previously TIME_ZERO).	2009-03-08 08:15:23 +00:00
readme.txt	Added shortcut to the web documentation.	2010-10-03 13:45:52 +00:00

readme.txt

*** 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 build procedure ***

The following software must be installed:
- 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.

Build procedure:
- Run Doxywizard.
- Load ./docs/Doxyfile from Doxywizard.
- Start.