如何利用doxygen生成pdf文档

 

自己工作中写的一个文档。希望能对有需要的人有所帮助。

                           How to generate pdf file

                                 with  Doxygen                                                                                             

Table of contents

   

How to 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 by	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 tag GENERATE_LATEX  and LATEX_OUTPUT to Yes. Also, to improve the quality of the pdf, the tag  PDF_HYPERLINKS and  USE_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 file  refman.tex in the Latex directory. And press PDF Latex button, then a pdf file will be generated in the same directory of the file refman.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 [email protected]