Doxygen Example of Function

Collaboration diagram for Doxygen Example of Function:

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

Detailed Description

Doxygen Example of Function.

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

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...