如何擴展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，則允許哪些偏差，並且可能會中斷。