是否可以使用 doxygen 生成 CMake 文档？

Question

我想使用 doxygen 为 .cmake 文件生成文档。我已经将 *.cmake \ 添加到 Doxyfile（doxygen 的配置）FILE_PATTERNS 部分，但似乎 doxygen 无法处理 .cmake 文件。

test.cmake

#[==[
@ingroup module-impl
@brief Output a node in the graph

Queries the properties for modules and generates the node for it in the graph
and its outgoing dependency edges.
#]==]
function (_anyfunction var module)
endfunction()

Answer 1

use doxygen to genererate CMake documentation?

你知道必须做什么。下载 Doxygen source and implement the support for CMake syntax and parsing comments in CMake, just like it is implemented for other languages. See https://www.doxygen.nl/support.html .

目前不支持 CMake。

Is it somehow possible

基本上写一个小的 compiler/parser，它获取 CMake 源代码并将其转换为短 C 或 Python 或其他编程语言源代码，然后通过生成的文件运行 Doxygen。

根据提供的格式，这将是一个简短的脚本，它搜索 fuction(... 行，提取函数名称，提取它前面的注释，并生成 // @brief-ish 注释，如后面的注释通过 void _anyFunction();.

你也可以这样做：

FILE_PATTERNS = *.cmake
EXTENSION_MAPPING = cmake=C  # or Python or other

然后尝试将其他编程语言压缩到 CMake 文件中：

#[=[*/
/// @function _anyFunction
/// @brief Output a node in the graph
///
/// Queries the properties for modules and generates the node for it in the graph
void _anyFunction();
#/*]=]
function (_anyfunction var module)
endfunction()

是否可以使用 doxygen 生成 CMake 文档？

Is it somehow possible to use doxygen to genererate CMake documentation?

doxygen

cmake