如何更改Doxygen中的功能签名?

时间:2012-05-23 15:25:34

标签: doxygen

在其他文档系统中,例如LuaDoc,有一个@brief指令允许您为每个使用实际令牌名称的标记定义自定义名称。

例如,您可以将一个实现为foo的函数在文档中显示为bar

如果您的源代码在编译之前通过某种非标准的预处理器,这可能非常方便。

或者如果您想使用Doxygen不支持的语言使用Doxygen,您必须使用过滤器脚本将其转换为Doxygen可以解析的内容。

有没有办法在Doxygen中实现此行为(仅为文档重命名标记)?

1 个答案:

答案 0 :(得分:1)

您可以使用INPUT_FILTER(所有文件的相同过滤器)或FILTER_PATTERNS(特定扩展名的过滤器)过滤输入文件。

通常情况下,不会处理源代码视图(即SOURCE_BROWSER=YES),但您可以使用FILTER_SOURCE_FILES=YES进行更改,如果您想使用不同的FILTER_SOURCE_PATTERNS,请将其与{{1}}结合使用过滤源代码而不是文档。

如果您使用源的传递过滤器和文档的令牌重命名过滤器,您应该能够获得您正在寻找的效果。