vnfs/VES5.0/doxygen-1.8.12/html/doxygen_usage.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Doxygen: Doxygen usage</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectalign" style="padding-left: 0.5em;">
  28    <div id="projectname">Doxygen
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.12 -->
  37 </div><!-- top -->
  38 <div id="side-nav" class="ui-resizable side-nav-resizable">
  39   <div id="nav-tree">
  40     <div id="nav-tree-contents">
  41       <div id="nav-sync" class="sync"></div>
  42     </div>
  43   </div>
  44   <div id="splitbar" style="-moz-user-select:none;"
  45        class="ui-resizable-handle">
  46   </div>
  47 </div>
  48 <script type="text/javascript">
  49 $(document).ready(function(){initNavTree('doxygen_usage.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Doxygen usage </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <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>
  58 <p>All options consist of a leading character <code>-</code>, followed by one character and one or more arguments depending on the option.</p>
  59 <p>To generate a manual for your project you typically need to follow these steps: </p><ol>
  60 <li>
  61 You document your source code with special documentation blocks (see section <a class="el" href="docblocks.html#specialblock">Special comment blocks</a>). </li>
  62 <li>
  63 You generate a configuration file (see section <a class="el" href="config.html">Configuration</a>) by calling doxygen with the <code>-g</code> option: <pre class="fragment">doxygen -g &lt;config_file&gt;
  64 </pre> </li>
  65 <li>
  66 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>
  67 <li>
  68 You let doxygen generate the documentation, based on the settings in the configuration file: <pre class="fragment">doxygen &lt;config_file&gt;
  69 </pre> </li>
  70 </ol>
  71 <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><pre class="fragment">doxygen -u &lt;config_file&gt;
  72 </pre><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>
  73 <h1><a class="anchor" id="doxygen_finetune"></a>
  74 Fine-tuning the output</h1>
  75 <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>
  76 <li>
  77 <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><pre class="fragment">doxygen -w html header.html footer.html stylesheet.css &lt;config_file&gt;
  78 </pre><p> The <code>config_file</code> is optional. When omitted doxygen will search for a file named <code>Doxyfile</code> and process that. When this is also not found it will used the default settings.</p>
  79 <p class="endli"></p>
  80 </li>
  81 <li>
  82 For <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> output, you can generate the first and last part of <code>refman.tex</code> (see <a class="el" href="config.html#cfg_latex_header">LATEX_HEADER</a> and <a class="el" href="config.html#cfg_latex_footer">LATEX_FOOTER</a>) and the style sheet included by that header (normally <code>doxygen.sty</code>), using the following command: <pre class="fragment">doxygen -w latex header.tex footer.tex doxygen.sty &lt;config_file&gt;
  83 </pre> If you need non-default options (for instance to use extra <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> packages) you need to make a config file with those options set correctly and then specify that config file after the generated files (make a backup of the configuration file first so you don't loose it in case you forget to specify one of the output files). </li>
  84 <li>
  85 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: <pre class="fragment">doxygen -w rtf rtfstyle.cfg
  86 </pre> </li>
  87 </ul>
  88 <dl class="section warning"><dt>Warning</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>
  89 <dl class="section note"><dt>Note</dt><dd><ul>
  90 <li>
  91 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>
  92 <li>
  93 To make doxygen read/write to standard input/output instead of from/to a file, use <code>-</code> for the file name. </li>
  94 </ul>
  95 </dd></dl>
  96 <p>
  97 Go to the <a href="doxywizard_usage.html">next</a> section or return to the
  98  <a href="index.html">index</a>.
  99  </p>
 100 </div></div><!-- contents -->
 101 </div><!-- doc-content -->
 102 <!-- start footer part -->
 103 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 104   <ul>
 105     <li class="footer">Generated by
 106     <a href="http://www.doxygen.org/index.html">
 107     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 108   </ul>
 109 </div>
 110 </body>
 111 </html>