Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the syntax of a static function?

Tags:

c

doxygen

I'm documenting code C with doxygen but this function can´t

/**
* @fn          void myApp_StartReporting( void )
*
* @brief       bla bla....
*
* @see     myAccReportPeriod
*
* @return      none
*/
static void myApp_StartReporting( void );

If remove static the documentation is ok.

Thank you very much.

like image 378
Jjreina Avatar asked Nov 21 '11 20:11

Jjreina


1 Answers

By default doxygen skips static functions. Did you set the EXTRACT_STATIC = YES option in your Doxyfile?

Also a style note (which was my first guess on what's wrong): If the documentation block is placed immediately before the entity that it describes the @fn tag is not needed.

like image 134
Anders Abel Avatar answered Oct 04 '22 01:10

Anders Abel