[Doxygen-users] Doxygen and C function names with modifiers with arguments

[Leonardo P. S. <Leo...@on...>]

I'm documenting some embedded C code and some functions have storage modifiers that are specific to the compiler, like so:

int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param)



Because the directive has a parameter, Doxygens interprets the directive as the function name.

The usual solution would be to use PREDEFINED directive in the Doxyfile as suggested here<http://doxygen.10944.n7.nabble.com/Is-it-possible-to-force-doxygen-to-ignore-compiler-specific-keywords-td2857.html> to completely ignore the storage modifier:



PREDEFINED             = chess_storage(x)=



The problem with this approach is that the documentation would not be accurate, as the actual function does have that modifier.

I've also tried to use @fn, but it didn't work either.



/**

 * @fn int firmware_function(unsigned long int param);

 *

 * A C function with a modifier

 *

 * @param param A parameter

 * @return zero.

 */

int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param);



So the goal here is not to ignore the parameter, but make Doxygen aware that it's just a word and treat it the same as a __near modifier.
Thank you!

____________________________________________________________
Leonardo Pereira Santos | ON Semiconductor
Design Engineer

200-611 Kumpf Dr        | Waterloo, Ontario, Canada, N2N 1A8
519-884-9696 x2269 (O)  | Leo...@on...<mailto:Leo...@on...>