Doxygen:添加新类型或结构

时间:2014-11-24 12:04:25

标签: doxygen doxygen-wizard

我想用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 个答案:

答案 0 :(得分:0)

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

PREDEFINED             = on=   

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

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

PREDEFINED             = on=void