Step 2: Run DOXYGEN
Enter the following command to generate a document:
DOXYGEN
Doxygen will generate an HTML, RTF, Latex, and Man Directory in the input directory, respectively correspond to HTML, RTF,
, UNIX-MAN file format.
The default output directory is the DOXYGEN directory. Use Output_Directory, HTML_Output, RTF_output, Latex_output, and Man_output to be modified. If the output directory does not exist, Doxygen will create it.
The generated HTML document requires a browser that supports CSS.
The generated
Documentation Must First Be Compiled by a
Compiler (I Use Tetex Distribution Version 0.9 That Contains
version 3.14159). To simplify the process of compiling the generated documentation, doxygen writes a Makefile into the latex directory. By typing make in the latex directory the dvi file refman.dvi will be generated (provided that you have a make tool called make of course). This file can then be viewed using xdvi or converted into a PostScript file refman.ps by typing make ps (this requires dvips). To put 2 pages on one physical page use make ps_2on1 instead. The resulting PostScript file can be send to a PostScript printer If you do not have a PostScript printer, you can try to use ghostscript to convert PostScript into something your printer understands Conversion to PDF is also possible if you have installed the ghostscript interpreter;.. just type make pdf (or make PDF_2on1). TO GET The Best Results for PDF Output You Should Set The PDF_HYPERLINKS TAG To YES.
Document must first pass
Compiler (I am TETEX VERSION 0.9 in hand)
Version 3.14159).
Step 3: Documenting The Sources Add comments for the source code
Although documenting the source is presented as step 3, in a new project this should of course be step 1. Here I assume you already have some code and you want doxygen to generate a nice document describing the API and maybe the internals as well.
If extract_all is set to No (Default) in the configuration file, Doxygen generates documents for Documented Members, Files, Classes, and Namespaces. So how should I add a comment for these elements? There are two basic options for MEMBERS, CLASSES, and NAMESPACES: 1. Add a Special Comment to MEMBER, CLASS, or NAMESPACE. For File, Class, and Namespace Members can also be added directly after this Member. Refer to the Special Documentation Blocks chapter.
2. Place a special document block elsewhere (another file or location) and place a Structural Command in this file block. A Structural Command IN is linked to a document block to a specific DocuMENTED (for example, a MEMBER, CLASS, NAMESPACE, or FILE). Refer to the Documentation At Other Places.
The file can only use the second option, because there is no way to put a comment block in front of the file. Of course, File Member (FUNCTIONS, VARIABLE, TYPEDEFS, Defines) does not require an explicit Structural Command; as long as it places a special annotation before and after it is OK.
The text in the special annotation block is written to HTML or
Before, it will be a PARSE.
There are following steps in Parse:
· Execute the Special Commands in the document
IF a line Starts with some white or more assetisks (*) and the all whitespace and askS are remodes.
• The blank line is considered a separator of the segment. No need to use a new-paragraph command.
· The word appears in the text, if match the DocuMENTED class, generate a link to the DocuMENTED class.
· Links to Members Are Created When Certain Patterns Are Found In The Text. See Automatic Link Generation for the automatic creation link.
· HTML Tags That Are In The Documentation Are Interpreted and Converted To
Equivalents for the
Output. See section HTML Commands for An Overview of All Supported HTML Tags.
