Blame doc/output.doc

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

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

Packit Service 50c9f2
Docbook
Packit Service 50c9f2
Generated if \ref cfg_generate_docbook "GENERATE_DOCBOOOK" is set to \c YES in the configuration file.

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