Doxygen Cheatsheet. A quick cheatsheet for Doxygen, adapted from [1]. File header. /** \file * Description of the file * * \author Olivier Mehani

Author: Akizilkree Mujora
Country: Bosnia & Herzegovina
Language: English (Spanish)
Genre: Education
Published (Last): 13 April 2013
Pages: 476
PDF File Size: 10.45 Mb
ePub File Size: 20.76 Mb
ISBN: 605-9-47659-405-2
Downloads: 67011
Price: Free* [*Free Regsitration Required]
Uploader: Nikree

As a suggested rule, this should only be information the reader can safely ignore, and of marginal interest like credits, inspirations and reasoning behind code. Part 2 is now out! This is a Doxygen flaw in my opinion: Fill in your details below or click an icon to log in: I want documents for file main.

Doxygen cheatsheet – Make More Machines

To do so, you need to put a structural command inside the documentation block. Modules can include files, namespaces, classes etc.

To document a global C function, typedefenum or preprocessor definition you must first document the file that contains it usually this will be a header file, because that file contains the information that doxyfen exported to other source files. Overloaded methods can be selected by incuding a list of argument types. For instance, if you want to document the class Testput the following documentation block somewhere in the input that is read by doxygen: Comment on parameter i, but function not documented!


Doxygen cheatsheet

Thank you for helping me improve the documentation for CartoType. Categories misc personal programming publications cneat software talks all tags Tweets by agapow.

Doxygen cheatsheet by Paul Agapow in programming tagged importedprogrammingtools Attention: This is a simple guide to basic use of Doxygen -compliant commenting of source code. A seperate “To Do” list will be generated and will cross-reference this entity. Markup for global cheay Post was not sent – check your email addresses! Note these are different to the module grouping tags.

The harder part is converting the old in-code documentation to Doxygen-compliant one. Simple guide to Doxygen – Linoleum. How to put the comment inside a function. I use the rth output. Hence why we want automation.

Doxygen cheatsheet ·

Groups Entities may be grouped into global modules, which appear together on a new page. For instance, if you want to document the class Testput the following documentation block somewhere in the input that is read by doxygen:. I have my config file set to hide other internal classes, but adding that comment above the class definition does not remove the class from the hceat. So for instance I have in public.


Installation and setup is very simple for all supported systems, and with Doxywizard, setting up the project of documentation is very simple also. Before the opening marker, a separate comment block may be placed that contains name and other information.

I wonder how to control the order that doxygen do the docomentaion. Doxygen is very flexible when it comes to the form of how the documentation is written, the layout presented here is simply my preference.

Doxygen Cheatsheet

It helps with those little annoying parts of doxygen. Markup for general information: Code may be documented in a number of styles, including the “JavaDoc” style: If no file name is given it is assumed this documentation belongs to the current chrat.

See Doxygen documentation for use for Python.

Main menu Skip to content. An entity can be made part of the group by using ingroup inside its documentation block.

Some markup for appearance: