Doxygen Example

Collaboration diagram for Doxygen Example:

Modules
	Sub Group of Doxygen Example

Data Structures
struct	dogygen_example_struct
struct	dogygen_example_struct_another
union	doxygen_example_union

Macros
#define	DOXYGEN_EXAMPLE_CONST_A   100
#define	DOXYGEN_EXAMPLE_CONST_B   200
#define	DOXYGEN_EXAMPLE_ABS(x)   (((x)>0)?(x):-(x))

Typedefs
typedef struct dogygen_example_struct	dogygen_example_struct_t
typedef struct dogygen_example_struct_another	dogygen_example_struct_another_t

Enumerations
enum	doxygen_example_enum { V1 , V2 }

Functions
void	doxygen_example_func_foo (int a, int b)
int	doxygen_example_func_bar (int a, int *b)

Detailed Description

Introduce how to write doxygen documentation.

Macro Definition Documentation

DOXYGEN_EXAMPLE_CONST_A

#define DOXYGEN_EXAMPLE_CONST_A   100

Description of macro const A

DOXYGEN_EXAMPLE_CONST_B

#define DOXYGEN_EXAMPLE_CONST_B   200

Description of macro const B

DOXYGEN_EXAMPLE_ABS

#define DOXYGEN_EXAMPLE_ABS

(

x

)

(((x)>0)?(x):-(x))

Computes the absolute value of its argument x.

Parameters

[in]

x

input value.

Returns

absolute value of x.

Typedef Documentation

dogygen_example_struct_t

dogygen_example_struct_t

Alias of struct dogygen_example_struct.

dogygen_example_struct_another_t

dogygen_example_struct_another_t

Alias of struct dogygen_example_struct_another.

Enumeration Type Documentation

doxygen_example_enum

enum doxygen_example_enum

Brief description of this enumeration.

Alias of enum doxygen_example_enum.

Enumerator
V1	description for value 1
V2	description for value 2

Function Documentation

doxygen_example_func_foo()

void doxygen_example_func_foo	(	int	a,
		int	b
	)

Brief description for the function.

Detailed description starts here, one line or multiple lines. Blah blah blah...

Parameters

[in]	a	Description of param a
[in]	b	Description of param b

Returns

void

Note

This is a note for this structure, blah blah blah...

doxygen_example_func_bar()

int doxygen_example_func_bar	(	int	a,
		int *	b
	)

Brief description for the function.

Detailed description starts here, one line or multiple lines. Blah blah blah...

Parameters

[in]	a	Description of param a
[out]	b	Description of param b

Returns

the return value, 0 for success, -1 for failure

Note

This is a note for this structure, blah blah blah...