|
1 /****************************************************************************** |
|
2 * |
|
3 * |
|
4 * |
|
5 * Copyright (C) 1997-2008 by Dimitri van Heesch. |
|
6 * |
|
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. |
|
12 * |
|
13 * Documents produced by Doxygen are derivative works derived from the |
|
14 * input used in their production; they are not affected by this license. |
|
15 * |
|
16 */ |
|
17 /*! \page output Output Formats |
|
18 |
|
19 \section output_sec Output Formats |
|
20 |
|
21 \addindex output formats |
|
22 |
|
23 The following output formats are \e directly supported by doxygen: |
|
24 <dl> |
|
25 <dt><b>HTML</b> |
|
26 <dd>Generated if \c GENERATE_HTML is set to \c YES in the configuration file. |
|
27 <dt>\f$\mbox{\LaTeX}\f$ |
|
28 <dd>Generated if \c GENERATE_LATEX is set to \c YES in the configuration file. |
|
29 <dt><b>Man pages</b> |
|
30 <dd>Generated if \c GENERATE_MAN is set to \c YES in the configuration file. |
|
31 <dt><b>RTF</b> |
|
32 <dd>Generated if \c GENERATE_RTF is set to \c YES in the configuration file.<p> |
|
33 Note that the RTF output probably only looks nice with Microsoft's |
|
34 Word 97. If you have success with other programs, please let me know. |
|
35 <dt><b>XML</b> |
|
36 <dd>Generated if \c GENERATE_XML is set to \c YES in the configuration file.<p> |
|
37 <dt><b>Qt Help Project (.qhp)</b> |
|
38 <dd>Generated if \c GENERATE_QHP is set to \c YES in the configuration file. |
|
39 </dl> |
|
40 |
|
41 The following output formats are \e indirectly supported by doxygen: |
|
42 <dl> |
|
43 <dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help) |
|
44 <dd>Generated by Microsoft's HTML Help workshop from the HTML output if |
|
45 \c GENERATE_HTMLHELP is set to \c YES. |
|
46 <dt><b>Qt Compressed Help (.qch)</b> |
|
47 <dd>Generated by Qt's qhelpgenerator tool from the HTML output if |
|
48 \c GENERATE_QHP is set to \c YES. |
|
49 <dt><b>PostScript</b> |
|
50 <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by |
|
51 running <code>make ps</code> in the output directory. |
|
52 For the best results \c PDF_HYPERLINKS should be set to \c NO. |
|
53 <dt><b>PDF</b>\htmlonly \endhtmlonly |
|
54 <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by |
|
55 running <code>make pdf</code> in the output directory. |
|
56 To improve the PDF output, you typically would want to enable the use |
|
57 of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the |
|
58 configuration file. In order to get hyperlinks in the PDF file you also need to enable |
|
59 \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS". |
|
60 </dl> |
|
61 |
|
62 */ |