Blame doc/output.doc

Packit 1c1d7e
/******************************************************************************
Packit 1c1d7e
 *
Packit 1c1d7e
 * 
Packit 1c1d7e
 *
Packit 1c1d7e
 * Copyright (C) 1997-2015 by Dimitri van Heesch.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Permission to use, copy, modify, and distribute this software and its
Packit 1c1d7e
 * documentation under the terms of the GNU General Public License is hereby 
Packit 1c1d7e
 * granted. No representations are made about the suitability of this software 
Packit 1c1d7e
 * for any purpose. It is provided "as is" without express or implied warranty.
Packit 1c1d7e
 * See the GNU General Public License for more details.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Documents produced by Doxygen are derivative works derived from the
Packit 1c1d7e
 * input used in their production; they are not affected by this license.
Packit 1c1d7e
 *
Packit 1c1d7e
 */
Packit 1c1d7e
/*! \page output Output Formats
Packit 1c1d7e
Packit 1c1d7e
\addindex output formats
Packit 1c1d7e
Packit 1c1d7e
The following output formats are \e directly supported by doxygen:
Packit 1c1d7e
Packit 1c1d7e
HTML
Packit 1c1d7e
Generated if \ref cfg_generate_html "GENERATE_HTML" is set to \c YES in the configuration file.
Packit 1c1d7e
\LaTeX
Packit 1c1d7e
Generated if \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES in the configuration file.
Packit 1c1d7e
Man pages
Packit 1c1d7e
Generated if \ref cfg_generate_man "GENERATE_MAN" is set to \c YES in the configuration file.
Packit 1c1d7e
RTF
Packit 1c1d7e
Generated if \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES in the configuration file.

Packit 1c1d7e
    Note that the RTF output probably only looks nice with Microsoft's 
Packit 1c1d7e
    Word. If you have success with other programs, please let me know.
Packit 1c1d7e
XML
Packit 1c1d7e
Generated if \ref cfg_generate_xml "GENERATE_XML" is set to \c YES in the configuration file.

Packit 1c1d7e
Docbook
Packit 1c1d7e
Generated if \ref cfg_generate_docbook "GENERATE_DOCBOOOK" is set to \c YES in the configuration file.

Packit 1c1d7e
Packit 1c1d7e
Packit 1c1d7e
The following output formats are \e indirectly supported by doxygen:
Packit 1c1d7e
Packit 1c1d7e
Compiled HTML Help (a.k.a. Windows 98 help)
Packit 1c1d7e
Generated by Microsoft's HTML Help workshop from the HTML output if
Packit 1c1d7e
    \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
Packit 1c1d7e
Qt Compressed Help (.qch)
Packit 1c1d7e
Generated by Qt's qhelpgenerator tool from the HTML output if
Packit 1c1d7e
    \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
Packit 1c1d7e
Eclipse Help
Packit 1c1d7e
Generated from HTML with a special index file that is generated when
Packit 1c1d7e
    \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" is set to \c YES.
Packit 1c1d7e
XCode DocSets
Packit 1c1d7e
Compiled from HTML with a special index file that is generated when
Packit 1c1d7e
    \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
Packit 1c1d7e
PostScript
Packit 1c1d7e
Generated from the \LaTeX output by
Packit 1c1d7e
    running make ps in the output directory.
Packit 1c1d7e
    For the best results \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" should be set to \c NO.
Packit 1c1d7e
PDF\htmlonly    \endhtmlonly
Packit 1c1d7e
Generated from the \LaTeX output by
Packit 1c1d7e
    running make pdf in the output directory.
Packit 1c1d7e
    To improve the PDF output, you typically would want to enable the use 
Packit 1c1d7e
    of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the 
Packit 1c1d7e
    configuration file. In order to get hyperlinks in the PDF file you also need to enable
Packit 1c1d7e
    \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS".
Packit 1c1d7e
Packit 1c1d7e
Packit 1c1d7e
Packit 1c1d7e
\htmlonly
Packit 1c1d7e
Go to the next section or return to the
Packit 1c1d7e
 index.
Packit 1c1d7e
\endhtmlonly
Packit 1c1d7e
Packit 1c1d7e
*/