3

I have a C code as below

#define RTC_SECOND_MAX 60u
/* Maximum count for the minute */
#define RTC_MINUTE_MAX 60u
/* Maximum count for the hour */
#define RTC_HOUR_MAX   24u

#define FUNC(rettype, memclass) rettype


/*****************************************************************************/
/* Global variable definitions (declared in header file with 'extern')       */
/*****************************************************************************/
/*****************************************************************************/
/* Local variable definitions ('static')                                     */
/*****************************************************************************/

/*****************************************************************************/
/* Local function prototypes ('static')                                      */
/*****************************************************************************/

/** 
 ** \brief CheckClockTime
 **
 ** This checks, if the given clock is meaningful
 **
 ** \return E_OK:     The given clock time is valid
 **         E_NOT_OK: The given clock time is invalid.
 ** \param [in] ClockCheck   clock to be checked
 **
 */
**
static FUNC(Std_ReturnType, AUTOMATIC) CheckClockTime
(
  CONST(Rtc_ClockType, AUTOMATIC) ClockCheck
);

Here function "CheckClockTime()" has type which is a function macro "FUNC()". This FUNC() is macro which returns a "rettype".

When I use Doxygen to generate Documentation for this code. I get something as shown in image attached. It seems like Doxygen is not parsing a function type which is a function macro. How can I parse this to Doxygen?

FUNC() is parsed as function but not type

2

0

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.