|
Revision 687, 1.4 kB
(checked in by peter, 2 years ago)
|
|
Merge changes from mainline upto r685.
This branch is now fully merged. Any remaining problems in doxygen, scripts
and tsuite should now be resolved.
|
-
Property svn:eol-style set to
native
|
| Line | |
|---|
| 1 | Readme for Doxygen |
|---|
| 2 | |
|---|
| 3 | quick start: |
|---|
| 4 | create the documentation with the command |
|---|
| 5 | doxygen Doxyfile |
|---|
| 6 | |
|---|
| 7 | Doxygen is a source code documentation system that is widely used in open source projects. It is available on the web at http://www.stack.nl/~dimitri/doxygen/ You will need a copy of the doxygen executable on your system to create the documentation. |
|---|
| 8 | |
|---|
| 9 | Doxygen must be able to find the open source program graphviz that is used to create equations from embedded LaTex. Download graphviz from http://www.graphviz.org/ |
|---|
| 10 | |
|---|
| 11 | This directory includes the setup file "Doxyfile" that is needed to run doxygen. The Cloudy download does not include the output documentation it generates. To create documentation run doxygen with the command |
|---|
| 12 | doxygen Doxyfile |
|---|
| 13 | in this directory. Doxgyen will create a new html directory below this one. The index.html file in the html directory is the top of the documentation. |
|---|
| 14 | |
|---|
| 15 | The manual for doxygen can be found at http://www.stack.nl/~dimitri/doxygen/download.html#latestman |
|---|
| 16 | The full description of its commands is under "Special Commands" in the "Reference Manual" section. |
|---|
| 17 | |
|---|
| 18 | The document file doxygen_setup_style.txt in this directory contains some notes on how Cloudy uses doxygen. |
|---|
| 19 | |
|---|
| 20 | ============================================== |
|---|
| 21 | |
|---|
| 22 | the file Doxyfile was created with the gui that is lauchned with the command |
|---|
| 23 | doxywizard Doxyfile |
|---|
| 24 | this is used to set the parameters for the generated output. |
|---|
| 25 | |
|---|
| 26 | Good luck, |
|---|
| 27 | Gary Ferland |
|---|
| 28 | http://www.nublado.org |
|---|
