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

Question

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

现在，我们也想在Lua部分使用Doxygen。 但是Doxygen缺乏对Lua的支持。

有一个项目增加了Lua对Doxygen的支持。 它是用Perl编写的，我知道它的作用。 它实现了一个过滤器，该过滤器将Lua源文件转换为Doxygen可以解析的文件。 但是，Doxygen似乎无法识别所有功能等。

所以我的问题确实是：Doxygen期望过滤器提供什么格式？

Answer 1

严格的答案是您的过滤器应使用doxygen支持的语言生成语法上有效的输出（您可以使用EXTENSION_MAPPING将您的语言的文件扩展名映射到支持的语言）。

由于doxygen的解析器相当松散（它是一个词法扫描器，而不是真正的解析器），所以如果您不100％遵循该语言的语法规则，它也可能会起作用，但是要找出它是一个麻烦和错误的过程如果您升级到未来版本的doxygen，则允许哪些偏差，并且可能会中断。