doc/output.doc

   1 /******************************************************************************
   2  *
   3  *
   4  *
   5  * Copyright (C) 1997-2012 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 \addindex output formats
  20
  21 The following output formats are \e directly supported by doxygen:
  22 <dl>
  23 <dt><b>HTML</b>
  24 <dd>Generated if \c GENERATE_HTML is set to \c YES in the configuration file.
  25 <dt>\f$\mbox{\LaTeX}\f$
  26 <dd>Generated if \c GENERATE_LATEX is set to \c YES in the configuration file.
  27 <dt><b>Man pages</b>
  28 <dd>Generated if \c GENERATE_MAN is set to \c YES in the configuration file.
  29 <dt><b>RTF</b>
  30 <dd>Generated if \c 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.
  33 <dt><b>XML</b>
  34 <dd>Generated if \c GENERATE_XML is set to \c YES in the configuration file.<p>
  35 </dl>
  36
  37 The following output formats are \e indirectly supported by doxygen:
  38 <dl>
  39 <dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help)
  40 <dd>Generated by Microsoft's HTML Help workshop from the HTML output if
  41     \c GENERATE_HTMLHELP is set to \c YES.
  42 <dt><b>Qt Compressed Help (.qch)</b>
  43 <dd>Generated by Qt's qhelpgenerator tool from the HTML output if
  44     \c GENERATE_QHP is set to \c YES.
  45 <dt><b>Eclipse Help</b>
  46 <dd>Generated from HTML with a special index file that is generated when
  47     \c GENERATE_ECLIPSEHELP is set to \c YES.
  48 <dt><b>XCode DocSets</b>
  49 <dd>Compiled from HTML with a special index file that is generated when
  50     \c GENERATE_DOCSET is set to \c YES.
  51 <dt><b>PostScript</b>
  52 <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by
  53     running <code>make ps</code> in the output directory.
  54     For the best results \c PDF_HYPERLINKS should be set to \c NO.
  55 <dt><b>PDF</b>\htmlonly &nbsp;&nbsp;&nbsp;\endhtmlonly
  56 <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by
  57     running <code>make pdf</code> in the output directory.
  58     To improve the PDF output, you typically would want to enable the use
  59     of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the
  60     configuration file. In order to get hyperlinks in the PDF file you also need to enable
  61     \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS".
  62 </dl>
  63
  64 */