output.doc 2.71 KB
Newer Older
mueller's avatar
mueller committed
1 2
/******************************************************************************
 *
dimitri's avatar
dimitri committed
3
 * 
mueller's avatar
mueller committed
4
 *
dimitri's avatar
dimitri committed
5
 * Copyright (C) 1997-2012 by Dimitri van Heesch.
mueller's avatar
mueller committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
dimitri's avatar
dimitri committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
mueller's avatar
mueller committed
15 16
 *
 */
dimitri's avatar
dimitri committed
17
/*! \page output Output Formats
mueller's avatar
mueller committed
18 19 20 21 22 23

\addindex output formats

The following output formats are \e directly supported by doxygen:
<dl>
<dt><b>HTML</b>
mueller's avatar
mueller committed
24
<dd>Generated if \c GENERATE_HTML is set to \c YES in the configuration file.
mueller's avatar
mueller committed
25
<dt>\f$\mbox{\LaTeX}\f$
mueller's avatar
mueller committed
26
<dd>Generated if \c GENERATE_LATEX is set to \c YES in the configuration file.
mueller's avatar
mueller committed
27
<dt><b>Man pages</b>
mueller's avatar
mueller committed
28
<dd>Generated if \c GENERATE_MAN is set to \c YES in the configuration file.
dimitri's avatar
dimitri committed
29 30 31
<dt><b>RTF</b>
<dd>Generated if \c GENERATE_RTF is set to \c YES in the configuration file.<p>
    Note that the RTF output probably only looks nice with Microsoft's 
dimitri's avatar
dimitri committed
32
    Word. If you have success with other programs, please let me know.
dimitri's avatar
dimitri committed
33 34
<dt><b>XML</b>
<dd>Generated if \c GENERATE_XML is set to \c YES in the configuration file.<p>
mueller's avatar
mueller committed
35 36 37 38
</dl>

The following output formats are \e indirectly supported by doxygen:
<dl>
dimitri's avatar
dimitri committed
39
<dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help)
mueller's avatar
mueller committed
40 41
<dd>Generated by Microsoft's HTML Help workshop from the HTML output if 
    \c GENERATE_HTMLHELP is set to \c YES.
dimitri's avatar
dimitri committed
42 43 44
<dt><b>Qt Compressed Help (.qch)</b>
<dd>Generated by Qt's qhelpgenerator tool from the HTML output if 
    \c GENERATE_QHP is set to \c YES.
dimitri's avatar
dimitri committed
45 46 47 48 49 50
<dt><b>Eclipse Help</b>
<dd>Generated from HTML with a special index file that is generated when
    \c GENERATE_ECLIPSEHELP is set to \c YES.
<dt><b>XCode DocSets</b>
<dd>Compiled from HTML with a special index file that is generated when
    \c GENERATE_DOCSET is set to \c YES.
dimitri's avatar
dimitri committed
51
<dt><b>PostScript</b>
mueller's avatar
mueller committed
52 53 54 55 56 57
<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by 
    running <code>make ps</code> in the output directory.
    For the best results \c PDF_HYPERLINKS should be set to \c NO.
<dt><b>PDF</b>\htmlonly &nbsp;&nbsp;&nbsp;\endhtmlonly
<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by
    running <code>make pdf</code> in the output directory.
dimitri's avatar
dimitri committed
58 59 60 61
    To improve the PDF output, you typically would want to enable the use 
    of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the 
    configuration file. In order to get hyperlinks in the PDF file you also need to enable
    \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS".
mueller's avatar
mueller committed
62 63 64
</dl>

*/