Techwizz/Gobligine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated info how to generate Doxygen documentation

Browse source
This commit is contained in:
Pali Rohár 2011-08-09 09:13:40 +02:00
parent 8d7e5b42d4
commit 36e429a50f
2 changed files with 16 additions and 6 deletions

19
doc/development.html
View file

@ -76,7 +76,7 @@ the directory and type 'bzr pull'.<p>
You can find instructions for compiling Stratagus at
<a href="install.html">install.html</a>.<br>
Since you already have a copy of the source, you may skip
ahead to step 2.
ahead to Installation Step 2.
<h2>Source code documentation</h2>
@ -85,9 +85,20 @@ documentation for Stratagus.<p>
You need
<a href="http://www.doxygen.org">DoxyGen</a>
to generate source code documentation. Documentation is generated
when Stratagus is compiling. After compilation is availabe
<a href="doxygen/index.html">here</a>
to generate source code documentation.<p>
Having DoxyGen installed, compile Stratagus with option ENABLE_DOC=ON<br>
(e.g, inside build directory, run 'cmake -DENABLE_DOC=ON .. &amp;&amp; make').<p>
Source documents are initially generated inside the build directory, as done for binaries.<p>
After installing stratagus (using 'make install') you can find all these html files in<br>
<u>share/doc/stratagus</u> directory.<p>
When installing Stratagus html these files are copied into <u>PREFIX/share/stratagus/doc</u>.<br>
Doxygen documentation is copied into <u>PREFIX/share/stratagus/doc/doxygen</u>.<p>
If you are viewing installed stratagus documentation, Doxygen documentation is here: <a href="doxygen/index.html">doxygen/index.html</a>
<h3>Tags used in source code</h3>

3
doc/index.html
View file

@ -80,8 +80,7 @@
<h2>Documentation</h2>
Source code DoxyGen documentation is generated when Stratagus is compiling.
After Stratagus compilation can be found in the
<a href="doxygen/index.html">source code documentation</a>.<p>
See <a href="development.html">development.html</a> for further details.<p>
Information about creating sounds and graphics can be found in the
<a href="media.html">media documentation</a>.<p>