Configuring and Using Doxygen: Difference between revisions
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. | 1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. | ||
There is also support for generating output in PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. | There is also support for generating output in PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, | ||
which makes it much easier to keep the documentation consistent with the source code. | |||
2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions. | 2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions. | ||