[Doxygen-users] Language extension not being removed

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

Hello all!

I'm documenting some DSP code that use a language extension. I've tried to follow the documentation here:

https://www.doxygen.nl/manual/preprocessing.html

My function is as follows:

/**
* @brief       Set the internal oscillator base operating frequency; the
*              oscillator multiplication setting is not a component
*              of the base operating frequency configuration.
* @param[in]   frequency_index Index corresponding to the desired
*                              trim value in the calibration table.
*                              Operating frequency index; use
*                              SYS_FREQ_*
* @return      If 0, new operating frequency set If 1, could not set frequency
*              (no calibration found for the requested operating frequency)
* @assumptions Calibration table loaded.
*
* @examplecode syslib_c_examples.c SYSLIB_SetOperatingFrequency_Example
* @examplecode syslib_examples.S SYSLIB_SetOperatingFrequency_ASM_Example
*/
extern "C" uint24_t chess_storage(x0) SYSLIB_SetOperatingFrequency(
       uint24_t chess_storage(x0) frequency_index);


My Doxyfile has:


ENABLE_PREPROCESSING    = YES
MACRO_EXPANSION         = YES
EXPAND_ONLY_PREDEF      = YES
PREDEFINED              = __attribute__(x)
PREDEFINED              = chess_storage(x)=


According to the documentation, the above should "will make sure the __declspec(dllexport) is removed before doxygen parses the source code."

However, that's not what I'm seeing. I have a warning when running Doxygen:


warning: argument 'frequency_index' of command @param is not found in the argument list of chess_storage(x0)

And the output thinks chess_storage is the function name:



uint24_t

chess_storage<group___s_y_s_l_i_bg.html#ga35208b7fdf582aa39608ca71b0d50282> (x0) SYSLIB_SetOperatingFrequency(uint24_t chess_storage(x0) frequency_index)



Set the internal oscillator base operating frequency; the oscillator multiplication setting is not a component of the base operating frequency configuration. More...<group___s_y_s_l_i_bg.html#ga35208b7fdf582aa39608ca71b0d50282>



Could someone help understand what I'm doing wrong?

Thank you very much!

Best Regards,

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