...
| Code Block | ||||
|---|---|---|---|---|
| ||||
cd tool mkdir -p ../build/tool/doc/interface ../build/tool/doc/internals doxygen interface.doxy doxygen internals.doxy |
Making the PDF file requires an extra step since Doxygen writes only LaTeX input with a Makefile to run pdflatex:
| Code Block | ||||
|---|---|---|---|---|
| ||||
cd ../build/tool/doc/interface/latex
make -i pdf
|
The resulting document is always called refman.pdf. You need to use -i with make because sometimes the LaTeX message about bad cross-references doesn't go away even though the document is OK.
I envisage two versions of code docs per project, one documenting just the public interface and the other all the internals as well. Both documents are prepared from the same source code files but using different Doxgen options. In the source code you can use the @internal command inside any Doxygen comment. The documentation that follows is considered to be internal until the end of the comment or an @endinternal command. When in the project directory the command
...