vnfs/VES5.0/doxygen-1.8.12/html/doxywizard_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: Doxywizard 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('doxywizard_usage.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Doxywizard usage </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <div class="textblock"><p>Doxywizard is a GUI front-end for configuring and running doxygen.</p>
  58 <p>Note it is possible to start the doxywizard with as argument the configuration file to be used.</p>
  59 <p>When you start doxywizard it will display the main window (the actual look depends on the OS used).</p>
  60 <div class="image">
  61 <img src="doxywizard_main.png" alt="doxywizard_main.png"/>
  62 <div class="caption">
  63 Main window</div></div>
  64 <p>The windows shows the steps to take to configure and run doxygen. The first step is to choose one of the ways to configure doxygen. </p><dl>
  65 <dt>Wizard</dt>
  66 <dd>Click this button to quickly configure the most important settings and leave the rest of the options to their defaults. </dd>
  67 <dt>Expert</dt>
  68 <dd>Click this button to gain access to the <a class="el" href="config.html">full range of configuration options</a>. </dd>
  69 <dt>Load</dt>
  70 <dd>Click this button to load an existing configuration file from disk. </dd>
  71 </dl>
  72 <p>Note that you can select multiple buttons in a row, for instance to first configure doxygen using the Wizard and then fine tune the settings via the Expert.</p>
  73 <p>After doxygen is configured you need to save the configuration as a file to disk. This second step allows doxygen to use the configuration and has the additional advantage that the configuration can be reused to run doxygen with the same settings at a later point in time.</p>
  74 <p>Since some configuration options may use relative paths, the next step is to select a directory from which to run doxygen. This is typically the root of the source tree and will most of the time already be filled in correctly.</p>
  75 <p>Once the configuration file is saved and the working directory is set, you can run doxygen based on the selected settings. Do this by pressing the "Start" button. Once doxygen runs you can cancel it by clicking the same button again. The output produced by doxygen is captured and shown in a log window. Once doxygen finishes, the log can be saved as a text file.</p>
  76 <h3>The Wizard Dialog</h3>
  77 <p>If you select the Wizard button in step 1, then a dialog with a number of tabs will appear.</p>
  78 <div class="image">
  79 <img src="doxywizard_page1.png" alt="doxywizard_page1.png"/>
  80 <div class="caption">
  81 Wizard dialog: Project settings</div></div>
  82 <p>The fields in the project tab speak for themselves. Once doxygen has finished the Destination directory is where to look for the results. Doxygen will put each output format in a separate sub-directory.</p>
  83 <div class="image">
  84 <img src="doxywizard_page2.png" alt="doxywizard_page2.png"/>
  85 <div class="caption">
  86 Wizard dialog: Mode of operating</div></div>
  87 <p>The mode tab allows you to select how doxygen will look at your sources. The default is to only look for things that have been documented.</p>
  88 <p>You can also select how doxygen should present the results. The latter does not affect the way doxygen parses your source code.</p>
  89 <div class="image">
  90 <img src="doxywizard_page3.png" alt="doxywizard_page3.png"/>
  91 <div class="caption">
  92 Wizard dialog: Output to produce</div></div>
  93 <p>You can select one or more of the output formats that doxygen should produce. For HTML and <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> there are additional options.</p>
  94 <div class="image">
  95 <img src="doxywizard_page4.png" alt="doxywizard_page4.png"/>
  96 <div class="caption">
  97 Wizard dialog: Diagrams to generate</div></div>
  98 <p>Doxygen can produce a number of diagrams. Using the diagrams tab you can select which ones to generate. For most diagrams the dot tool of the <a href="http://www.graphviz.org">GraphViz</a> package is needed (if you use the binary packages for MacOSX this tool is already included).</p>
  99 <h3>Expert dialog</h3>
 100 <p>The Expert dialog has a number of tab fields, one for each section in the configuration file. Each tab-field contains a number of lines, one for each configuration option in that section.</p>
 101 <p>The kind of input widget depends on the type of the configuration option. </p><ul>
 102 <li>
 103 For each boolean option (those options that are answered with YES or NO in the configuration file) there is a check-box. </li>
 104 <li>
 105 For items taking one of a fixed set of values (like <a class="el" href="config.html#cfg_output_language">OUTPUT_LANGUAGE</a>) a combo box is used. </li>
 106 <li>
 107 For items taking an integer value from a range, a spinbox is used. </li>
 108 <li>
 109 For free form string-type options there is a one line edit field </li>
 110 <li>
 111 For options taking a lists of strings, a one line edit field is available, with a `+' button to add this string to the list and a `-' button to remove the selected string from the list. There is also a `*' button that, when pressed, replaces the selected item in the list with the string entered in the edit field. </li>
 112 <li>
 113 For file and folder entries, there are special buttons that start a file selection dialog. </li>
 114 </ul>
 115 <div class="image">
 116 <img src="doxywizard_expert.png" alt="doxywizard_expert.png"/>
 117 <div class="caption">
 118 Some options from the Expert dialog</div></div>
 119 <p>The get additional information about the meaning of an option, click on the "Help" button at the bottom right of the dialog and then on the item. A tooltip with additional information will appear.</p>
 120 <h3>Menu options</h3>
 121 <p>The GUI front-end has a menu with a couple of useful items</p>
 122 <div class="image">
 123 <img src="doxywizard_menu.png" alt="doxywizard_menu.png"/>
 124 <div class="caption">
 125 File menu</div></div>
 126 <dl>
 127 <dt>Open...</dt>
 128 <dd>This is the same as the "Load" button in the main window and allows to open a configuration file from disk. </dd>
 129 <dt>Save as..</dt>
 130 <dd>This is the same as the "Save" button in the main window and can be used to save the current configuration settings to disk. </dd>
 131 <dt>Recent configurations</dt>
 132 <dd>Allow to quickly load a recently saved configuration. </dd>
 133 <dt>Set as default...</dt>
 134 <dd>Stores the current configuration settings as the default to use next time the GUI is started. You will be asked to confirm the action. </dd>
 135 <dt>Reset...</dt>
 136 <dd>Restores the factory defaults as the default settings to use. You will be asked to confirm the action. </dd>
 137 </dl>
 138 <p>
 139 Go to the <a href="config.html">next</a> section or return to the
 140  <a href="index.html">index</a>.
 141  </p>
 142 </div></div><!-- contents -->
 143 </div><!-- doc-content -->
 144 <!-- start footer part -->
 145 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 146   <ul>
 147     <li class="footer">Generated by
 148     <a href="http://www.doxygen.org/index.html">
 149     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 150   </ul>
 151 </div>
 152 </body>
 153 </html>