<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Doxygen manual: Doxygen usage</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Doxygen manual</div> </td> </tr> </tbody> </table> </div> </div> <div class="header"> <div class="headertitle"> <div class="title">Doxygen usage </div> </div> </div> <div class="contents"> <div class="textblock"><p>Doxygen is a command line based utility. Calling <code>doxygen</code> with the <code>--help</code> option at the command line will give you a brief description of the usage of the program.</p> <p>All options consist of a leading character <code>-</code>, followed by one character and one or more arguments depending on the option.</p> <p>To generate a manual for your project you typically need to follow these steps: </p> <ol> <li> You document your source code with special documentation blocks (see section <a class="el" href="docblocks.html#specialblock">Special documentation blocks</a>). </li> <li> You generate a configuration file (see section <a class="el" href="config.html">Configuration</a>) by calling doxygen with the <code>-g</code> option: <div class="fragment"><pre class="fragment"> doxygen -g <config_file> </pre></div> </li> <li> You edit the configuration file so it matches your project. In the configuration file you can specify the input files and a lot of optional information. </li> <li> You let doxygen generate the documentation, based on the settings in the configuration <a href="file:">file:</a> <div class="fragment"><pre class="fragment"> doxygen <config_file> </pre></div> </li> </ol> <p>If you have a configuration file generated with an older version of doxygen, you can upgrade it to the current version by running doxygen with the -u option. </p> <div class="fragment"><pre class="fragment"> doxygen -u <config_file> </pre></div><p> All configuration settings in the original configuration file will be copied to the new configuration file. Any new options will have their default value. Note that comments that you may have added in the original configuration file will be lost.</p> <h2><a class="anchor" id="doxygen_finetune"></a> Fine-tuning the output</h2> <p>If you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, and footer files that you can edit afterwards: </p> <ul> <li> <p class="startli">For HTML output, you can generate the default header file (see <a class="el" href="config.html#cfg_html_header">HTML_HEADER</a>), the default footer (see <a class="el" href="config.html#cfg_html_footer">HTML_FOOTER</a>), and the default style sheet (see <a class="el" href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a>), using the following command: </p> <div class="fragment"><pre class="fragment"> doxygen -w html header.html footer.html stylesheet.css <config_file> </pre></div><p> The config_file is optional. When omitted doxygen will search for a file named Doxyfile and process that. When this is also not found it will used the default settings.</p> <p class="endli"></p> </li> <li> For LaTeX output, you can generate the first part of <code>refman.tex</code> (see <a class="el" href="config.html#cfg_latex_header">LATEX_HEADER</a>) and the style sheet included by that header (normally <code>doxygen.sty</code>), using: <div class="fragment"><pre class="fragment"> doxygen -w latex header.tex doxygen.sty </pre></div> If you need non-default options (for instance to use pdflatex) you need to make a config file with those options set correctly and then specify that config file as the third argument. </li> <li> For RTF output, you can generate the default style sheet file (see <a class="el" href="config.html#cfg_rtf_stylesheet_file">RTF_STYLESHEET_FILE</a>) using: <div class="fragment"><pre class="fragment"> doxygen -w rtf rtfstyle.cfg </pre></div> </li> </ul> <dl class="warning"><dt><b>Warning:</b></dt><dd>When using a custom header you are responsible for the proper inclusion of any scripts and style sheets that doxygen needs, which is dependent on the configuration options and may changes when upgrading to a new doxygen release.</dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd><ul> <li> If you do not want documentation for each item inside the configuration file then you can use the optional <code>-s</code> option. This can use be used in combination with the <code>-u</code> option, to add or strip the documentation from an existing configuration file. Please use the <code>-s</code> option if you send me a configuration file as part of a bug report! </li> <li> To make doxygen read/write to standard input/output instead of from/to a file, use <code>-</code> for the file name. </li> </ul> </dd></dl> </div></div> <hr class="footer"/><address class="footer"><small>Generated on Mon Jun 27 2011 for Doxygen manual by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>
