Doxygen：添加新类型或结构

【问题标题】：Doxygen: Add new type or structureDoxygen：添加新类型或结构
【发布时间】：2015-01-22 03:25:54
【问题描述】：

我想使用 doxygen 来记录类似 c 的语言。我遇到了一些问题来解决上下文中未知的关键字。

举个例子，我必须使用一个叫做

的回调函数

on timer
{
  //normal c- code
}

我现在的问题是，我可以采用 doxygen 来接受新的关键字吗？我想像函数或变量 acc 一样添加这个关键字。到

/** This timer is used for something. */   
on timer
{
}

或许

/** \ontimer This timer is used for something. */   
on timer
{
}

doxygen 的文档描述了 ALIASES 或 \xrefitem 的内容，但据我所知，我只能为已知类型生成新部分，还是我错了？实际上，我用条件块包围了未知代码，以避免生成的输出中出现错误。

【问题讨论】：

【解决方案1】：

据我了解，“on”是 doxygen 无法解释的关键字。一种解决方案是使用 PREDEFINED 标记将关键字 on 声明为 doxyile 中的预定义宏，如下所示：

PREDEFINED             = on=

是的，最后的= 不是错字！这告诉 doxygen 的预处理器将关键字 on 替换为空字符串。请注意，您必须将ENABLE_PREPROCESSING 设置为YES。

如果on 关键字只出现在回调函数之前，您也可以将PREDEFINED 宏设置为void：

PREDEFINED             = on=void

【讨论】：