lua - 如何扩展 Doxygen 以支持 Lua？或 : how to write Doxygen filters?

Question

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

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

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

所以我的问题真的是:Doxygen 对过滤器的期望格式是什么？

Answer 1

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

由于 doxygen 的解析器相当松散(它是一个词法扫描器，而不是真正的解析器)，如果您不 100% 遵循该语言的语法规则，它可能也能正常工作，但这将是一个循序渐进的过程来找出如果您升级到 doxygen 的 future 版本，哪些偏差是允许的并且可能会中断。