VES5.0/doxygen-1.8.12/html/index.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: Main Page</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('index.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Doxygen Documentation</div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <div class="textblock"><center>
  58 <img src="doxygen_logo.gif" width="634" height="197" alt="doxygen"/><br/>
  59 Version:
  60  </center><h2>Introduction</h2>
  61 <p>Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.</p>
  62 <p>Doxygen can help you in three ways: </p><ol>
  63 <li>
  64 It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. </li>
  65 <li>
  66 You can <a class="el" href="starting.html#extract_all">configure</a> doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. </li>
  67 <li>
  68 You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site). </li>
  69 </ol>
  70 <p>Doxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.</p>
  71 <p><br />
  72 This manual is divided into three parts, each of which is divided into several sections.</p>
  73 <p>The first part forms a user manual: </p><ul>
  74 <li>
  75 Section <a class="el" href="install.html">Installation</a> discusses how to <a href="http://www.doxygen.org/download.html">download</a>, compile and install doxygen for your platform. </li>
  76 <li>
  77 Section <a class="el" href="starting.html">Getting started</a> tells you how to generate your first piece of documentation quickly. </li>
  78 <li>
  79 Section <a class="el" href="docblocks.html">Documenting the code</a> demonstrates the various ways that code can be documented. </li>
  80 <li>
  81 Section <a class="el" href="markdown.html">Markdown support</a> show the Markdown formatting supported by doxygen. </li>
  82 <li>
  83 Section <a class="el" href="lists.html">Lists</a> shows how to create lists. </li>
  84 <li>
  85 Section <a class="el" href="grouping.html">Grouping</a> shows how to group things together. </li>
  86 <li>
  87 Section <a class="el" href="formulas.html">Including formulas</a> shows how to insert formulas in the documentation. </li>
  88 <li>
  89 Section <a class="el" href="diagrams.html">Graphs and diagrams</a> describes the diagrams and graphs that doxygen can generate. </li>
  90 <li>
  91 Section <a class="el" href="preprocessing.html">Preprocessing</a> explains how doxygen deals with macro definitions. </li>
  92 <li>
  93 Section <a class="el" href="autolink.html">Automatic link generation</a> shows how to put links to files, classes, and members in the documentation. </li>
  94 <li>
  95 Section <a class="el" href="output.html">Output Formats</a> shows how to generate the various output formats supported by doxygen. </li>
  96 <li>
  97 Section <a class="el" href="searching.html">Searching</a> shows various ways to search in the HTML documentation. </li>
  98 <li>
  99 Section <a class="el" href="extsearch.html">External Indexing and Searching</a> shows how use the external search and index tools </li>
 100 <li>
 101 Section <a class="el" href="customize.html">Customizing the output</a> explains how you can customize the output generated by doxygen. </li>
 102 <li>
 103 Section <a class="el" href="custcmd.html">Custom Commands</a> show how to define and use custom commands in your comments. </li>
 104 <li>
 105 Section <a class="el" href="external.html">Linking to external documentation</a> explains how to let doxygen create links to externally generated documentation. </li>
 106 <li>
 107 Section <a class="el" href="faq.html">Frequently Asked Questions</a> gives answers to frequently asked questions. </li>
 108 <li>
 109 Section <a class="el" href="trouble.html">Troubleshooting</a> tells you what to do when you have problems. </li>
 110 </ul>
 111 <p>The second part forms a reference manual:</p>
 112 <ul>
 113 <li>
 114 Section <a class="el" href="features.html">Features</a> presents an overview of what doxygen can do. </li>
 115 <li>
 116 Section <a class="el" href="doxygen_usage.html">Doxygen usage</a> shows how to use the <code>doxygen</code> program. </li>
 117 <li>
 118 Section <a class="el" href="doxywizard_usage.html">Doxywizard usage</a> shows how to use the <code>doxywizard</code> program. </li>
 119 <li>
 120 Section <a class="el" href="config.html">Configuration</a> shows how to fine-tune doxygen, so it generates the documentation you want. </li>
 121 <li>
 122 Section <a class="el" href="commands.html">Special Commands</a> shows an overview of the special commands that can be used within the documentation. </li>
 123 <li>
 124 Section <a class="el" href="htmlcmds.html">HTML Commands</a> shows an overview of the HTML commands that can be used within the documentation. </li>
 125 <li>
 126 Section <a class="el" href="xmlcmds.html">XML Commands</a> shows an overview of the C# style XML commands that can be used within the documentation. </li>
 127 </ul>
 128 <p>The third part provides information for developers:</p>
 129 <ul>
 130 <li>
 131 Section <a class="el" href="arch.html">Doxygen's Internals</a> gives a global overview of how doxygen is internally structured. </li>
 132 <li>
 133 Section <a class="el" href="perlmod.html">Perl Module Output</a> shows how to use the PerlMod output. </li>
 134 <li>
 135 Section <a class="el" href="langhowto.html">Internationalization</a> explains how to add support for new output languages. </li>
 136 </ul>
 137 <p><br />
 138 </p><h2>Doxygen license</h2>
 139 <p><a name="alicense"></a> <a name="aGPL"></a></p>
 140 <p>Copyright &copy; 1997-2016 by <a href="#" onclick="location.href='mai'+'lto:'+'dim'+'it'+'ri@'+'st'+'ack'+'.n'+'l'; return false;">Dimitri van Heesch</a>.</p>
 141 <p>Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License</a> for more details. </p>
 142 <p>Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.</p>
 143 <h2>User examples</h2>
 144 <p>Doxygen supports a number of <a class="el" href="output.html">output formats</a> where HTML is the most popular one. I've gathered <a href="http://www.doxygen.org/results.html">some nice examples</a> of real-life projects using doxygen.</p>
 145 <p>These are part of a larger <a href="http://www.doxygen.org/projects.html">list of projects</a> that use doxygen. If you know other projects, let <a href="#" onclick="location.href='mai'+'lto:'+'dim'+'it'+'ri@'+'st'+'ack'+'.n'+'l?s'+'ub'+'jec'+'t='+'New'+'%2'+'0pr'+'oj'+'ect'+'%2'+'0us'+'in'+'g%2'+'0D'+'oxy'+'ge'+'n'; return false;">me</a> know and I'll add them.</p>
 146 <h2>Future work</h2>
 147 <p>Although doxygen is successfully used by large number of companies and open source projects already, there is always room for improvement. </p>
 148 <p>You can submit enhancement requests in <a href="https://bugzilla.gnome.org/buglist.cgi?product=doxygen&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_severity=enhancement">the bug tracker</a>. Make sure the severity of the bug report is set to "enhancement".</p>
 149 <h2>Acknowledgments</h2>
 150 <p><a name="aacknowledgments"></a> Thanks go to: </p><ul>
 151 <li>
 152 <a name="aDoc:2b:2b"></a> Malte Z&ouml;ckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen. </li>
 153 <li>
 154 All people at Qt Software, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-) </li>
 155 <li>
 156 My brother Frank for rendering the logos. </li>
 157 <li>
 158 Harm van der Heijden for adding HTML help support. </li>
 159 <li>
 160 Wouter Slegers of <a href="http://www.yourcreativesolutions.nl">Your Creative Solutions</a> for registering the www.doxygen.org domain. </li>
 161 <li>
 162 Parker Waechter for adding the RTF output generator. </li>
 163 <li>
 164 Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator. </li>
 165 <li>
 166 Tim Mensch for adding the todo command. </li>
 167 <li>
 168 Christian Hammond for redesigning the web-site. </li>
 169 <li>
 170 Ken Wong for providing the HTML tree view code. </li>
 171 <li>
 172 Talin for adding support for C# style comments with XML markup. </li>
 173 <li>
 174 Petr Prikryl for coordinating the internationalization support. All language maintainers for providing translations into many languages. </li>
 175 <li>
 176 The band <a href="http://www.porcupinetree.com">Porcupine Tree</a> for providing hours of great music to listen to while coding. </li>
 177 <li>
 178 many, many others for suggestions, patches and bug reports. </li>
 179 </ul>
 180 <p>
 181 Go to the <a href="install.html">next</a> section.
 182  </p>
 183 </div></div><!-- contents -->
 184 </div><!-- doc-content -->
 185 <!-- start footer part -->
 186 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 187   <ul>
 188     <li class="footer">Generated by
 189     <a href="http://www.doxygen.org/index.html">
 190     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 191   </ul>
 192 </div>
 193 </body>
 194 </html>