Doxygen generic API

The Doxygen generic API allows to model a C or C++ structure. Note that:

• The elements described here are the parent type of the element
• It is not necessary to specify if you are describing a C or C++ API

See Generic apidocs API types for the list of parent element for each API element.

C++ structure

The structure of the API for the C++ language is the following:

• Only "class" and "enum" parent elements can be at the root of each API
• A "class" parent element can have "method" or "field" children. note that a "constructor", "destructor", "getter", and "setter" are "method" elements

C structure

The structure of the API for the C language is the following:

• Only "header"," struct" and "enum" parent elements can be at the root of each API
• A "header" parent element can have "macro", "typedef", "function", and "enum" children
• A "struct" parent element can have "field" children
• An "enum" parent element can have "constant" children. Note that an enum state is a "constant"

List of managed types

The following table presents the list of parent types which are managed by the Doxygen generic API.

Parent Type	Top Element	Comment
header	Yes	Represents a C header
class	Yes	Represents a class
struct	Yes	Represents a structure
enum	Yes	Represents an enum
method	No	Represents a method, a constructor, a destructor, a getter, or a setter
field	No	Represents a class field or a structure field
typedef	No	Represents a typedef declaration
macro	No	Represents a macro declaration
constant	No	Represents a constant used for enum states, typedef, or macro
argument	No	Represents an argument
function	No	Represents a C function