How to Use doxygen to generate PDF documents

 

A document written in your work. Hope to help people in need.

How to generate PDF file with doxygen

Table of contents

How
Generate PDF file with doxygen. 1

Distribution. 2

History of change. 2

Introduction. 2

Generate latex files. 2

Convert latex to PDF. 2

 

Distribution

 

Name	Company	Reason
David	Kisters AG	Created

 

 

History of change

 

Version	Date	Changed	Changed chapters	Reason of change
Version 1.0:	2009.4.15	David	-	Created.

 

Introduction

As we know,
Doxygen is a very convenient tool to generate documentation of widespread
Formats. Usually, the output format is HTML, and doxygen can generate HTML directly.
However, it needs extra work to generate PDF documentation, because doxygen
Only generate latex files which can be transformed to PDF.

Generate latex files

Suppose you
Are familiar with doxygen, otherwise, you need to learn to use doxygen before
You read this document.

To generate a PDF file, you should enable
Output Format latex, set the tagGenerate_latexAndLatex_output
To yes. Also, to improve the quality of the PDF, the tagPdf_hyperlinks
AndUse_pdflatex
Need to be set to yes.

After
Then, run doxygen, then latex files will be generated in the output directory
Under the directory "latex ".

Convert
Latex to PDF

Now you
Have latex files, you need to transform the latex files to PDF. There are
Several tools that you can use. One popular one is miktex. It is free to use,
You can find the software at http://miktex.org /.

Currently
I am using another tool called ctex which is a Chinese version of miktex. You
Can find the package at www.ctex.org

After
Ctex is installed, you can use winedit (which is a tool in the package) to open
The fileRefman. TexIn the latex directory.
And pressPDF LatexButton, then
PDF file will be generated in the same directory of the fileRefman. Tex.

After the PDF file is generated, You need to press button
Makeindex to generage index for the PDF file. Since winedit is not free, you only have 30 trial days.
However, all this can be done without winedit. You can type command "pdflatex" and
"Makeindex" in the command prompt.

 

For more information, please contanct bicheng.gui@gmail.com