如何使用Doxygen记录C函数宏?

时间:2016-04-15 12:31:06

标签: c doxygen

我有一个C代码,如下所示

#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
);

此处功能" CheckClockTime()"具有函数宏的类型" FUNC()"。这个FUNC()是宏,它返回一个" rettype"。

当我使用Doxygen为此代码生成文档时。我得到的东西如附图所示。似乎Doxygen没有解析函数类型,它是一个函数宏。我该如何解析Doxygen?

FUNC() is parsed as function but not type

0 个答案:

没有答案