Contents 
 Index 
 "TPT User's Guide" 
 < Previous 
 Next > 

PDF Output

Doxygen does not generate PDF files directly. Instead, it generates LaTex files at the same time that HTML is generated.

The GENERATE_LATEX and the HTML_OUTPUT tags are defined in the project file so that Doxygen generates HTML output.

Then the 45_latex_build.b shell script:

• Calls voyant_latex.pl which creates appropriate refman.tex and doxygen.sty files for each zlx_ directory in the project.

• For each zlx_ directory in the project,

• Calls LaTex several times in order to generate the table of contents, the index, and resolve cross-references.

• Creates a postscript file for each.

• Creates a PDF file.

Doxygen does support a LATEX_HEADER tag that can be used to specify a personal header for the generated document. The header should contain everything until the first chapter. In order to accomplish this, you have to be a LaTex expert. If I would have known more LaTex, maybe voyant_latex.pl would not have been required.

The PDF output (at the time of writing) does have some limitations.

• The PDF output contains everything in the HTML system, sometimes with a bit too much white space and redundancy (which is useful in the HTML system). In the PDF, it starts looking like filler rather than important content.

• The PDF files from Doxygen/LaTex often have large page counts. This necessitated warnings in the HTML system about not blindly printing PDF files.

• In order to change the PDF output and tweak it for your needs, you need to be a LaTex expert.

• When a Doxygen project uses tag files and is dependent on another project, the PDF output is incomplete.

However, the PDF output from Doxygen is still useful. It offers more control in the print layout and in printing page ranges. PDF has its own search capabilities.



 "TPT User's Guide" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-hug-02