0

我想使用 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 的内容,但据我所知,我只能为已知类型生成新部分,还是我错了?实际上,我用条件块包围了未知代码,以避免生成的输出中出现错误。

4

1 回答 1

0

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

PREDEFINED             = on=   

是的,=最后不是错字!这告诉 doxygen 的预处理器用on空字符串替换关键字。请注意,您必须设置ENABLE_PREPROCESSINGYES.

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

PREDEFINED             = on=void
于 2015-10-27T14:14:39.577 回答