andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ChibiOS/docs
History
gdisirio 8b763a660f Fixed bug 3294998. 
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/stable_2.2.x@2999 35acf78f-673a-0410-8e92-d51de3d6d3f4
 		2011-05-24 17:30:00 +00:00
..
html Documentation improvements. 2009-03-02 15:42:19 +00:00
reports Reports updated running 2.2.4. 2011-05-21 08:01:59 +00:00
rsc Added shortcut to the web documentation. 2010-10-03 13:45:52 +00:00
src License exception added. 2011-01-16 10:45:21 +00:00
Doxyfile Fixed bug 3294998. 2011-05-24 17:30:00 +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.