59 lines
5.2 KiB
HTML
59 lines
5.2 KiB
HTML
<html><head><title>Doxygen</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Doxygen</h1></div>
|
|
|
|
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><div id="itsfree" style="text-align:center;color:black;background:#FDE0A8;margin:1em 7em;padding:0.5em 2em;border:2px solid #FF5706;">Future home of tutorial how to write doxygen for FreeCAD
|
|
<a href="/wiki/Source_documentation#How_to_integrate_doxygen_in_to_the_FreeCAD_source_code" title="Source documentation">Source_documentation#How_to_integrate_doxygen_in_to_the_FreeCAD_source_code</a></div>
|
|
<p><br />
|
|
</p>
|
|
<div id="toc" class="toc"><div class="toctitle"><h2>Contents</h2></div>
|
|
<ul>
|
|
<li class="toclevel-1 tocsection-1"><a href="#Background"><span class="tocnumber">1</span> <span class="toctext">Background</span></a></li>
|
|
<li class="toclevel-1 tocsection-2"><a href="#Explanation_of_doxygen_markup"><span class="tocnumber">2</span> <span class="toctext">Explanation of doxygen markup</span></a></li>
|
|
<li class="toclevel-1 tocsection-3"><a href="#FreeCAD_doxygen"><span class="tocnumber">3</span> <span class="toctext">FreeCAD doxygen</span></a>
|
|
<ul>
|
|
<li class="toclevel-2 tocsection-4"><a href="#FC_doxygen_formatting"><span class="tocnumber">3.1</span> <span class="toctext">FC doxygen formatting</span></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<h3><span class="mw-headline" id="Background">Background</span></h3>
|
|
<p>From the Doxygen <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/starting.html#step3">help file</a>:
|
|
For members, classes and namespaces there are basically two options:
|
|
</p>
|
|
<ol><li> Place a special documentation block in front of the declaration or definition of the member, class or namespace. For file, class and namespace members it is also allowed to place the documentation directly after the member.
|
|
<dl><dd> See section <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#specialblock">Special comment blocks</a> to learn more about special documentation blocks.</dd></dl></li>
|
|
<li> Place a special documentation block somewhere else (another file or another location) and put a structural command in the documentation block. A structural command links a documentation block to a certain entity that can be documented (e.g. a member, class, namespace or file).
|
|
<dl><dd> See section <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands">Documentation at other places</a> to learn more about structural commands.</dd></dl></li></ol>
|
|
<p>Note:
|
|
</p>
|
|
<ul><li>The advantage of the first option is that you do not have to repeat the name of the entity.</li>
|
|
<li>Files can only be documented using the second option, since there is no way to put a documentation block before a file. Of course, file members (functions, variables, typedefs, defines) do not need an explicit structural command; just putting a special documentation block in front or behind them will work fine.</li></ul>
|
|
<h3><span class="mw-headline" id="Explanation_of_doxygen_markup">Explanation of doxygen markup</span></h3>
|
|
<ul><li> <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdaddtogroup"><b>\addtogroup</b></a> <code>\addtogroup <name> [(title)]</code></li>
|
|
<li> <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdbrief"><b>\brief</b></a> <code>\brief { brief description }</code> </li>
|
|
<li> <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam"><b>\param</b></a> <code>\param [(dir)] <parameter-name> { parameter description }</code> </li>
|
|
<li> <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdreturn"><b>\return</b></a> <code>\return { description of the return value }</code> (syn. \returns)</li>
|
|
<li> <a rel="nofollow" class="external text" href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdnote"><b>\note</b></a> <code>\note { text }</code></li></ul>
|
|
<h3><span class="mw-headline" id="FreeCAD_doxygen">FreeCAD doxygen</span></h3>
|
|
<h4><span class="mw-headline" id="FC_doxygen_formatting">FC doxygen formatting</span></h4>
|
|
<p>The FC project has chosen the following method for it's doxygen comment blocks:
|
|
As it's special char of choice
|
|
<code>
|
|
</p><p></code>
|
|
</p>
|
|
<ul><li> <b>\note</b> ex. <code>\note added in FreeCAD 0.17</code></li></ul>
|
|
<p>Note: Please also read: <a rel="nofollow" class="external free" href="https://github.com/FreeCAD/FreeCAD/blob/master/src/Doc/doctips.dox">https://github.com/FreeCAD/FreeCAD/blob/master/src/Doc/doctips.dox</a>
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div><div class="printfooter">
|
|
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Doxygen&oldid=223103">http://www.freecadweb.org/wiki/index.php?title=Doxygen&oldid=223103</a>"</div>
|
|
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
<div id="mw-navigation">
|
|
<h2>Navigation menu</h2>
|
|
|
|
</body></html> |