Linux Today: Linux News On Internet Time.

Learning Doxygen for Source Code Documentation

Aug 06, 2008, 04:30 (0 Talkback[s])
(Other stories by Arpan Sen)

[ Thanks to BlueVoodoo for this link. ]

"Doxygen can generate documentation in several output formats other than HTML. You can configure doxygen to produce documentation in the following formats:

UNIX man pages: Set the tag to Yes. By default, a sub-folder named man is created within the directory provided using , and the documentation is generated inside the folder. You must add this folder to the MANPATH environment variable.
Rich Text Format (RTF): Set the tag to Yes. Set the to wherever you want the .rtf files to be generated—by default, the documentation is within a sub-folder named rtf within the OUTPUT_DIRECTORY. For browsing across documents, set the tag to Yes. If set, the generated .rtf files contain links for cross-browsing.
Latex: By default, doxygen generates documentation in Latex and HTML formats. The tag is set to Yes in the default Doxyfile. Also, the tag is set to Latex, which implies that a folder named latex would be generated inside OUTPUT_DIRECTORY, where the Latex files would reside..."

Complete Story

Related Stories: