如何扩展Doxygen以支持Lua?或者:如何编写Doxygen过滤器?

时间:2012-05-23 14:44:54

标签: lua doxygen

我正在开发一个半Lua和一半C ++的代码库。我们使用Doxygen来记录我们的C ++代码。

现在,我们也希望将Doxygen用于Lua部分。但Doxygen缺乏对Lua的支持。

a project这样可以增加Lua对Doxygen的支持。它是用Perl编写的,我理解它的作用。它实现了一个过滤器,可以将Lua源文件转换为Doxygen可以解析的内容。但是,Doxygen似乎并不能识别所有功能等。

所以我的问题是:Doxygen希望过滤器的格式是什么?

1 个答案:

答案 0 :(得分:4)

严格的答案是你的过滤器应该在doxygen支持的语言中产生语法上有效的输出(你可以使用EXTENSION_MAPPING将你语言的文件扩展名映射到支持的语言。)

由于doxygen的解析器相当松散(它是一个词法扫描器,而不是真正的解析器),如果你不100%遵循该语言的语法规则,它也可以工作,但它将是一个跟踪错误的过程找出哪些偏差是允许的,如果升级到doxygen的未来版本,可能会中断。