Create Documentation with Doxygen
From mangos
Contents |
What is doxygen?
Doxygen is a tool for writing software reference documentation. The documentation is written within code, and is thus relatively easy to keep up to date. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code.
Creating the documentation
You just have to edit the doxy-config-file and run doxygen, but at first download the mangos sourcecode and doxygen and install doxygen.
Edit the config-file
Open the Doxygen.in in mangos\doc and use the editor´s find/replace-function for these changes:
@PACKAGE@ -> mangos
@VERSION@ -> "revision" for example rev9972
@top_srcdir@/ -> ../
@srcdir@/ -> ./
Run doxygen
Open cmd and go to the folder mangos\doc and run the command: doxygen Doxyfile.in
That s it. Open index.html in mangos\doc\html with your browser and enjoy.
