feedlooki.blogg.se - Doxygen link to class

Doxygen link to class manual#
Doxygen link to class code#

There's also support for generating output in RTF (MS Word), PostScript, hyperlinked PDF, compressed HTML, DocBook, and Unix man pages.

Doxygen link to class manual#

A link to a member in this class: member (). Doxygen: Doxygen generates an on-line documentation browser (in HTML) or an off-line reference manual (in LaTeX) from a set of documented source files. Links to the destructor are: AutolinkTest and AutolinkTest ().

Doxygen link to class code#

For functions and variables, this has the drawback that you have to duplicate your declarations (once in the code and once in the comment block) and that it is not obvious if something has been documented or not.īesides these options, many IDE's also have features to collapse various structures, like comment blocks, in such a way that they become unintrusive for looking at the actual code. Two ways to link to a constructor are: AutolinkTest and AutolinkTest (). Use doxygen commands like \class, \fn or \var to link the comment block to the element it is documenting, rather than the placement of the comment block.Place the documentation for member functions with the out-of-class definition of the function In case of function and class names, Doxygen is smart and will automatically create a link to the documentation of a function or class whenever it is mentioned.

Int var /*!< Detailed description after the member */

To manually specify link text, use the HTML ' a ' tag: link text which will be automatically translated to other output formats by doxygen. • Use trailing documentation comments after (member) variables and/or enumerators: In as such, ACS uses the defgroup tag provided by Doxygen on the typedef which in turn places a link to the newly created class in modules.html (linked to. Doxygen will automatically replace any URLs and mail addresses found in the documentation by links (in HTML). This function tries to find a member (in a documented class/file/namespace) that corresponds to the function/variable declaration given in funcDecl. The argument can be used to overwrite the name of the link that is used in the class documentation to something other than .

Some ways to have documentation comments and keep your declarations together without intervening comment blocks are: Doxygen supports various ways to place your documentation comments, not just the big block before a declaration or definition.