1 /******************************************************************************
5 * Copyright (C) 1997-2015 by Dimitri van Heesch.
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation under the terms of the GNU General Public License is hereby
9 * granted. No representations are made about the suitability of this software
10 * for any purpose. It is provided "as is" without express or implied warranty.
11 * See the GNU General Public License for more details.
13 * Documents produced by Doxygen are derivative works derived from the
14 * input used in their production; they are not affected by this license.
17 /*! \page output Output Formats
19 \addindex output formats
21 The following output formats are \e directly supported by doxygen:
24 <dd>Generated if \ref cfg_generate_html "GENERATE_HTML" is set to \c YES in the configuration file.
26 <dd>Generated if \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES in the configuration file.
28 <dd>Generated if \ref cfg_generate_man "GENERATE_MAN" is set to \c YES in the configuration file.
30 <dd>Generated if \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES in the configuration file.<p>
31 Note that the RTF output probably only looks nice with Microsoft's
32 Word. If you have success with other programs, please let me know.
34 <dd>Generated if \ref cfg_generate_xml "GENERATE_XML" is set to \c YES in the configuration file.<p>
36 <dd>Generated if \ref cfg_generate_docbook "GENERATE_DOCBOOOK" is set to \c YES in the configuration file.<p>
39 The following output formats are \e indirectly supported by doxygen:
41 <dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help)
42 <dd>Generated by Microsoft's HTML Help workshop from the HTML output if
43 \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
44 <dt><b>Qt Compressed Help (.qch)</b>
45 <dd>Generated by Qt's qhelpgenerator tool from the HTML output if
46 \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
47 <dt><b>Eclipse Help</b>
48 <dd>Generated from HTML with a special index file that is generated when
49 \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" is set to \c YES.
50 <dt><b>XCode DocSets</b>
51 <dd>Compiled from HTML with a special index file that is generated when
52 \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
54 <dd>Generated from the \LaTeX output by
55 running <code>make ps</code> in the output directory.
56 For the best results \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" should be set to \c NO.
57 <dt><b>PDF</b>\htmlonly \endhtmlonly
58 <dd>Generated from the \LaTeX output by
59 running <code>make pdf</code> in the output directory.
60 To improve the PDF output, you typically would want to enable the use
61 of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the
62 configuration file. In order to get hyperlinks in the PDF file you also need to enable
63 \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS".
68 Go to the <a href="searching.html">next</a> section or return to the
69 <a href="index.html">index</a>.