Doxygen Quick Reference.pdf

Viewer
Transcript

Doxygen Quick Reference Doxygen commands Doxygen (http://www.doxygen.org/) reads a configuration file to control source code processing and documentation output formats, the default filename is Doxyfile. doxygen doxygen doxygen -g

Run with default config file. Run with . Generate .

Documenting the sources Doxygen-visible multi-line comment blocks begin with /**, or /*!, and end with */. Alternately, the of C++ single line comment delimiters /// or //! may be used on each line. Within a comment block HTML tags or Doxygen specific markup tags, Special Commands, can be used. Documentation comment blocks can occur anywhere in the source code but placing such blocks before defined code elements, classes, functions, etc., is recommended. Source code files should include the \file command to make comments in the file visible to Doxygen. Doxygen special commands, with a few exceptions, begin with the prefix @ or \, used in this document. Following the Doxygen manual convention, the command arguments are enclosed here in braces that signify the extent of the argument, these braces are not part of the command, nor should they be included in the command: < angle > ( round ) { curly }

angle braces: argument is a single word. round braces: argument extends to end of line. curly braces: argument extends to next paragraph.

other parts of the documentation as the first argument to a \ref ‘‘’’ command. This creates a link to the labeled group using the lnk text enclosed in quotes, the second argument is optional. The group members are enclosed by the group open @{ and close @} commands, as follows: /** \defgroup ‘‘’’ */ /* @{ */ // group members here ... /* @} */ where groups initiated by \name or \page commands have similar forms, see table below. The open and close group commands must be placed in a comment block, this can be a standard C-style comment or single line C++ comment. Elements may be members of multiple groups, which may lead to conflicts when generating documentation. Doxygen implements a priority scheme for group membership. The priorities are assigned based on the command used to initiate group membership. The priority order (highest to lowest) is \ingroup, \defgroup, \addtogroup, and \weakgroup \defgroup <l> ‘‘<t>’’ \name <l> \page <l> (t) \section <l> (t) \subsection <l> (t) \mainpage (t)<br /> <br /> Lists Column aligned hypens (-) create a unordered or bulleted list. Column aligned hypens with a pound-number symbol (-#) create an ordered or numbered list. Lists can be made heirachical using indentation levels, list items with identical column aligned symbols will appear at the same level of the heirarchy. Unordered and ordered lists can be mixed in a heirarchy. list item in unorderd list (column aligned). -# list item in orderd list (column aligned). \li list item in unorderd list. \arg equivalent to \li. <ul> HTML: starts an unordered list. </ul> HTML: ends an unordered list. <ol> HTML: starts an ordered list. </ol> HTML: ends an ordered list. <li> HTML: list item, between <[uo]l> and </[uo]l> pairs.<br /> <br /> Grouping Doxygen can group things in many ways. Groups are defined with either a \defgroup, \name or \page command with a label and optional title. The label can be used in<br /> <br /> \addtogroup <l> (t) \ingroup <l> \ref <l> ‘‘<t>’’ /* /* // //<br /> <br /> @{ */ @} */ @{ @{<br /> <br /> defines a module group with a label l and title t. defines a member group with a label l. defines a page group with a label l and title t. defines a section on a page with a label l and title t. defines a sub-section on a page with a label l and title t. defines a documentation block to place on the index page. adds to a group, enclose in openclose pairs. adds documentation to the l group. references group l using the optional link text t. comment to open a group block comment to close a group block comment to open a group block comment to open a group block<br /> <br /> Member group documentation will not appear under under a separate header-tab in the generated documentation. Module groups are defined with the \name <label> command in a comment block which is taken as the group header, which gives the group a label for later reference.<br /> <br /> Page Groups Page group documentation will appear under the Related Pages heading in the generated documentation. Page groups are defined with the \page <label> (title), which gives the group a label for later reference. and a title to display in the documenation. Pages can be further divided into sub-pages—with \sub-page <n> ‘‘<t>’’, sections and subsections, and sub-subsections with a command similar to: \section <section-name> (section title) . The name of the command simply changes to subsection or subsubsection as required. These commands give a label <section-name> and title (section title) to the section. A special case of a page group is the main page group. The Doxygen command \mainpage within a comment block places the documentation within that block on the Index page of the generated documentation. You can refer to the main page using \ref index (if the treeview is disabled, otherwise you should use \ref main).<br /> <br /> Formulas Doxygen can include LATEX formulas in the HTML and LATEX output formats. Formulas can p be included within the text of a single line, for example—r = (x − x0 )2 − (y − y0 )2 or as a centered formula such as (from the Doxygen manual):<br /> <br /> Z <br /> <br /> |I2 | = <br /> <br /> T<br /> <br /> <br /> <br /> Z<br /> <br /> a<br /> <br /> u(a, t) −<br /> <br /> ψ(t)<br /> <br /> 0<br /> <br /> γ(t)<br /> <br /> dθ k(θ, t)<br /> <br /> Z<br /> <br /> θ<br /> <br /> c(ξ)ut (ξ, t) dξ a<br /> <br /> dt <br /> <br /> To include an inline formula the command \f$ is used to begin and end the formula block, the above formula would appear in the documentation as \f$ \sqrt{(x-x_0)^2-(y-y_0)^2} \f$. A centered formula is enclosed by the Doxygen commands \f[ to open the formula block and \f] to close it. Additional LATEX equation environments, like eqnarray can be used with the commands \f{eqnarray} to open the formula block and \f} to close the block.<br /> <br /> Module Groups<br /> <br /> LATEX Formulas<br /> <br /> Module group documentation will appear under the Modules heading in the generated documentation. Module groups are defined with the \defgroup <label> ‘‘<title>’’, which gives the group a label for later reference. and a title to display in the documenation; title includes everything enclosed by quotes.<br /> <br /> LATEX formulas use a markup language with a rich set of tags which can be combined to typeset any formula. A brief sub-set of those commands is included here. Additional resources can be found on the web and in bookstores. x^{2} \frac{x}{y}<br /> <br /> x2 ; superscript<br /> <br /> Member Groups Member group are used when “a compound (e.g. a class or file) has many members, it is often desired to group them together”.<br /> <br /> \sum_{k=1}^n \pi<br /> <br /> Pn<br /> <br /> x y k=1<br /> <br /> π; small Greek<br /> <br /> x_{0} \sqrt[n]{x} \int_{a}^b dt \Pi<br /> <br /> x√ 0 ; subscript n x<br /> <br /> Rb<br /> <br /> dt a Π; capital Greek<br /> <br /> Graphs<br /> <br /> Structural Indicators<br /> <br /> Doxygen can produce graphs, generated by the dot tool from Graphviz (http://www.graphviz.org/). Graph generation by Doxygen is normally performed automatically based on settings in the configuration file. These settings, with the exception of DOT_PATH are either YES or NO. These are global settings for the project. Graphs will only be generated if you have dot installed and HAVE_DOT = YES. HAVE_DOT DOT_PATH GRAPHICAL_HIERARCHY CLASS_GRAPH INCLUDE_GRAPH CALL_GRAPH CALLER_GRAPH<br /> <br /> COLLABORATION_GRAPH<br /> <br /> signals that the dot tool is available. path todot tool, if not in $PATH. generate a graph of class heirarchy. generate inheritance graph for each documented class. generate dependency graph for each documented file. generate call graph for each documented function or method. generate a graph indicating functions called by the documented function. generate a graph showing inheritance and usage relationships between classes and structs.<br /> <br /> You can also use the dot language syntax to generate a graph. Commands specific to dot are enclosed in the Doxygen command pair \dot and \enddot.<br /> <br /> Special Commands A listing Doxygen specific commands by category.<br /> <br /> Text Formatting \a <word> word font face, equivalent to \e. \arg list item, equivalent to \li. \b <word> word font face. \c <word> word font face. \code starts a code block section. \endcode ends a \code section. \copydoc ref copies documenation from ref. \dot starts a dot graph block. \enddot ends a dot graph block. \e <word> word font face, equivalent to \a. √ \f$ starts and ends an inline formula, i.e. x. \f[ starts a centered formula block. \f] ends a centered formula block. \image <format> <file> ‘‘caption’’ places an image into the documentation with an optional caption \htmlonly starts a block for only HTML output. \endhtmlonly ends an HMTL only block. \n forces a new line. \p <word> word font face. \verbatim starts a block included as verbatim text. \endverbatim ends a verbatim text block.<br /> <br /> adds to a group, enclose in open-close pairs. \callgraph generates a call graph for function or method \callergraph generates a caller graph for function or method \category documentation block for a class category (Objective-C only). \class <c> [<f>] [<n>]documents the class c, header file f and header name n can be included. \def <name> documents the name #define macro \defgroup <l> ‘‘<t>’’ defines a module group with a label l and title t. \enum <name> documents the name enumeration \example <file> a documentation block for an example contained in file. \file <name> a documentation block for file name \fn <sig> documents the function with signature sig \hideinitializer hides the default value of a #define \ingroup <l1> [<l2>] adds documentation to the l1 group, multiple groups can be used. \interface <n> documentation block for interface n \internal all text following this is suppressed to the end of the comment block. \mainpage (t) the main or index page documentation block. \name (header) a member group documentation block. \namespace <n> a documenation block for namesapce n \nosubgrouping turns off sub-gropuing for a class. \overload (s) used to document an overloaded function with signature s \package <n>) a documentation block for package n \page <n> (t) indicates a page group documentation block with label n and title t \property (q) documentation for global or class property q \protocol (f) documentation block for a protocol (Objective-C only). \relates <n> used to relate non-member functions to classes \relatesalso <n> similar to \relates \showinitializer shows the default value of a #define \struct <n> documentation block for struct n \typedef (t) documentation block for typedef t \union <n> documentation block for union n \var (v) documentation block for variable v \weakgroup <n> equivalent to \addtogroup but has lower priority when resolving group conflicts. \addtogroup <l> (t)<br /> <br /> Section Indicators \attention {...} \author {loa} \brief {...} \bug {...} \cond <sec> \date {...} \deprecated {...} \else \elseif <sec> \endcond \endif \exception <e> \if <sec> \ifnot <sec> \invariant {...} \note {...} \par (t) {...}<br /> <br /> starts an Attention paragraph. includes the list of authors loa. a brief description of the element. a bug description. begins a conditional section.<br /> <br /> starts a Deprecated paragraph. additional clause to a \if command additional clause to a \cond command. ends a conditional section. ends an \if clause. starts an exception description for e starts a conditional section. starts a conditional section. starts a description of an invariant. starts a Note paragraph. starts a paragraph with and optional title (t). \param <p> {...} starts a description of parameter p. \post {...} starts a post-condition description. \pre {...} starts a pre-condition description. \remarks {...} starts a Remarks paragraph. \return {...} starts a description of return values. \retval <f> {...} describes a return value for function f \sa {ref} starts a See Also paragraph. \see {ref} equivalent to \sa. \since {...} describes since when an entity was available. \test {...} starts a test case description paragraph. \throw <e> {...} equivalent to exception \todo {...} starts a To Do paragraph. \version {...} starts a paragraph where version strings can be entered. \warning {...} starts a paragraph for warning messages. \xrefitem <k> ‘‘(h)’’ {.} creats a cross-refernced paragraph.<br /> <br /> Link Indicators adds t to the LATEX index. places invisible anchor w in the document. \endlink ends a link started with \link \link <n> {...} creates link to n with user specified link text. \ref <n> ‘‘(t)’’ creates a reference to n with text t. \subpage <n> ‘‘(t)’’ creates a sub-page of name n. \section <l> (t) creates a section on a page with a label l and title t. \subsection <l> (t) creates a sub-section on a page with a label l and title t. \paragraph <n> (t) creates a paragraph on a page with a label l and title t.<br /> <br /> \addindex (t) \anchor (w)<br /> <br /> 2006 - Paul W. Joireman, joireman@fnal.gov Based on the LATEX 2ε Cheat Sheet by Winston Chang For more detailed information consult the Doxygen manual http://www.stack.nl/ dimitri/doxygen/manual.html $Revision: 1.0 $, $Date: 2006/10/10 $.<br /> <br /> </div> </div> </div> </div> </div> </div> </div> <div class="col-lg-3 col-md-4 col-xs-12"> <div class="panel-meta panel panel-info"> <div class="panel-heading"> <h2 class="text-center panel-title">Doxygen Quick Reference.pdf</h2> </div> <div class="panel-body"> <div class="row"> <div class="col-md-12"> <span class="st">Page 1 of 2. Doxygen Quick Reference. Doxygen commands. Doxygen (http://<wbr>www.doxygen.org/) reads a configuration file. to control source code processing and documentation output. formats, the default filename is Doxyfile. doxygen Run with default config file. doxygen <config-file> Run with <config-file>. doxygen -g ...</wbr></span> </div> <div class="col-md-12"> <div class="doc"> <hr /> <div class="download-button" style="margin-right: 3px; margin-bottom: 6px;"> <a href="https://p.pdfkul.com/download/doxygen-quick-referencepdf_5ad8cef87f8b9a71108b457e.html" class="btn btn-success btn-block"><i class="fa fa-cloud-download"></i> Download PDF </a> </div> <div class="share-box pull-left" style="margin-right: 3px;">  <a href="http://www.facebook.com/sharer.php?u=https://p.pdfkul.com/doxygen-quick-referencepdf_5ad8cef87f8b9a71108b457e.html" target="_blank" class="btn btn-social-icon btn-facebook"> <i class="fa fa-facebook"></i> </a>  <a href="http://www.linkedin.com/shareArticle?mini=true&url=https://p.pdfkul.com/doxygen-quick-referencepdf_5ad8cef87f8b9a71108b457e.html" target="_blank" class="btn btn-social-icon btn-twitter"> <i class="fa fa-twitter"></i> </a> </div> <div class="fb-like pull-left" data-href="https://p.pdfkul.com/doxygen-quick-referencepdf_5ad8cef87f8b9a71108b457e.html" data-layout="button_count" data-action="like" data-size="large" data-show-faces="false" data-share="false"></div> <div class="clearfix"></div> <div class="row"> <div class="col-md-12" style="margin-top: 6px;"> <span class="btn pull-left" style="padding-left: 0;"><i class="fa fa-file-pdf-o"></i> 112KB Sizes</span> <span class="btn pull-left"><i class="fa fa-download"></i> 0 Downloads</span> <span class="btn pull-left" style="padding-right: 0;"><i class="fa fa-eye"></i> 42 Views</span> </div> </div> <div class="clearfix"></div> <div class="row"> <div class="col-md-12"> <span class="btn pull-left" style="padding-left: 0;"><a data-toggle="modal" data-target="#report" style="color: #f44336;"><i class="fa fa-handshake-o"></i> Report</a></span> </div> </div> </div> </div> </div> <h4 id="comment"></h4> <div id="fb-root"></div> <script> (function (d, s, id) { var js, fjs = d.getElementsByTagName(s)[0]; if (d.getElementById(id)) return; js = d.createElement(s); js.id = id; js.src = "//connect.facebook.net/en_GB/sdk.js#xfbml=1&version=v2.9&appId=266776430439748"; fjs.parentNode.insertBefore(js, fjs); }(document, 'script', 'facebook-jssdk')); </script> <div class="fb-comments" data-href="https://p.pdfkul.com/doxygen-quick-referencepdf_5ad8cef87f8b9a71108b457e.html" data-width="100%" data-numposts="6"></div> </div> </div> <div class="panel-recommend panel panel-success"> <div class="panel-heading"> <h4 class="text-center panel-title">Recommend Documents</h4> </div> <div class="panel-body"> <span>No documents</span> </div> </div> </div> </div> </div> <div class="modal fade" id="report" tabindex="-1" role="dialog" aria-hidden="true"> <div class="modal-dialog"> <div class="modal-content"> <form role="form" method="post" action="https://p.pdfkul.com/report/5ad8cef87f8b9a71108b457e" style="border: none;"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h4 class="modal-title">Report Doxygen Quick Reference.pdf</h4> </div> <div class="modal-body"> <div class="form-group"> <label>Your name</label> <input type="text" name="name" required="required" class="form-control" /> </div> <div class="form-group"> <label>Email</label> <input type="email" name="email" required="required" class="form-control" /> </div> <div class="form-group"> <label>Reason</label> <select name="reason" required="required" class="form-control"> <option value="">-Select Reason-</option> <option value="pornographic" selected="selected">Pornographic</option> <option value="defamatory">Defamatory</option> <option value="illegal">Illegal/Unlawful</option> <option value="spam">Spam</option> <option value="others">Other Terms Of Service Violation</option> <option value="copyright">File a copyright complaint</option> </select> </div> <div class="form-group"> <label>Description</label> <textarea name="description" required="required" rows="3" class="form-control"></textarea> </div> <div class="form-group"> <div style="display: inline-block;"> <div class="g-recaptcha" data-sitekey="6LeP2DsUAAAAAABvCByMZRCE253cahUVoC_jPUkq"></div> </div> </div> <script src='https://www.google.com/recaptcha/api.js'></script> </div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> <button type="submit" class="btn btn-primary">Save changes</button> </div> </form> </div> </div> </div>  <div class="modal fade" id="login" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"> <div class="modal-dialog" role="document"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close" on="tap:login.close"><span aria-hidden="true">×</span></button> <h3 class="modal-title">Sign In</h3> </div> <div class="modal-body"> <form action="https://p.pdfkul.com/login" method="post"> <div class="form-group form-group-lg"> <label class="sr-only" for="email">Email</label> <input class="form-input form-control" type="text" name="email" id="email" value="" placeholder="Email" /> </div> <div class="form-group form-group-lg"> <label class="sr-only" for="password">Password</label> <input class="form-input form-control" type="password" name="password" id="password" value="" placeholder="Password" /> </div> <div class="form-group form-group-lg"> <div class="checkbox"> <label class="form-checkbox"> <input type="checkbox" name="remember" value="1" /> <i class="form-icon"></i> Remember Password </label> <label class="pull-right"><a href="https://p.pdfkul.com/forgot">Forgot Password?</a></label> </div> </div> <button class="btn btn-lg btn-primary btn-block" type="submit">Sign In</button> </form> </div> </div> </div> </div>  <div class="footer-container" style="background: #fff;display: block;padding: 10px 0 20px 0;margin-top: 30px;"> <hr /> <div class="footer-container-inner"> <footer id="footer" class="container"> <div class="row">  <section class="block col-md-4 col-xs-12 col-sm-3" id="block_various_links_footer"> <h4>Information</h4> <ul class="toggle-footer" style=""> <li><a href="https://p.pdfkul.com/about">About Us</a></li> <li><a href="https://p.pdfkul.com/privacy">Privacy Policy</a></li> <li><a href="https://p.pdfkul.com/term">Terms and Service</a></li> <li><a href="https://p.pdfkul.com/copyright">Copyright</a></li> <li><a href="https://p.pdfkul.com/contact">Contact Us</a></li> </ul> </section>  <section id="social_block" class="col-md-4 col-xs-12 col-sm-3 block"> <h4>Follow us</h4> <ul> <li class="facebook"> <a target="_blank" href="" title="Facebook"> <i class="fa fa-facebook-square fa-2x"></i> <span>Facebook</span> </a> </li> <li class="twitter"> <a target="_blank" href="" title="Twitter"> <i class="fa fa-twitter-square fa-2x"></i> <span>Twitter</span> </a> </li> <li class="google-plus"> <a target="_blank" href="" title="Google Plus"> <i class="fa fa-plus-square fa-2x"></i> <span>Google Plus</span> </a> </li> </ul> </section>  <div id="newsletter" class="col-md-4 col-xs-12 col-sm-3 block"> <h4>Newsletter</h4> <div class="block_content"> <form action="https://p.pdfkul.com/newsletter" method="post"> <div class="form-group"> <input id="newsletter-input" type="text" name="email" size="18" placeholder="Entrer Email" /> <button type="submit" name="submit_newsletter" class="btn btn-default"> <i class="fa fa-location-arrow"></i> </button> <input type="hidden" name="action" value="0"> </div> </form> </div> </div>  </div> <div class="row"> <div class="bottom-footer"> <div class="container"> Copyright © 2025 P.PDFKUL.COM. All rights reserved. </div> </div> </div> </footer> </div> </div>  <script> $(function () { $("#document_search").autocomplete({ source: function (request, response) { $.ajax({ url: "https://p.pdfkul.com/suggest", dataType: "json", data: { term: request.term }, success: function (data) { response(data); } }); }, autoFill: true, select: function (event, ui) { $(this).val(ui.item.value); $(this).parents("form").submit(); } }); }); </script>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-VPK2MQK127"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-VPK2MQK127'); </script> </body> </html>