Doxygen 文档答案

【问题标题】：Doxygen documentationDoxygen 文档
【发布时间】：2021-02-04 20:34:44
【问题描述】：

我最近开始在 clion 中使用 doxygen。我在 CMAKELIST 中使用它编译代码时让 doxygen 创建了所有 htlm 文件：

find_package(Doxygen)
if(DOXYGEN_FOUND)
    set(BUILD_DOC_DIR "${CMAKE_SOURCE_DIR}/docs/output")
    if(NOT EXISTS "${BUILD_DOC_DIR}")
        file(MAKE_DIRECTORY "${BUILD_DOC_DIR}")
    endif()

    set(DOXYGEN_IN "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")
    set(DOXYGEN_OUT "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
    configure_file("${DOXYGEN_IN}" "${DOXYGEN_OUT}" @ONLY)

    message("Doxygen build started")
    add_custom_target(Doxygen ALL
            COMMAND "${DOXYGEN_EXECUTABLE}" "${DOXYGEN_OUT}"
            WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
            COMMENT "Generating API documentation with Doxygen"
            VERBATIM)
else(DOXYGEN_FOUND)
    message("Doxygen needs to be installed to generate the documentation.")
endif(DOXYGEN_FOUND)

但是当我编译代码时，doxygen 不仅为我自己的函数创建了一个 htlm，因为它实际上为来自 clion 的每个函数创建了一个文档。有没有办法让它只为我自己的编码函数创建那个 htlm 文件？

【问题讨论】：

您使用的是哪个版本的 doxygen？ “它实际上为 clion 的每个函数创建了一个文档”是什么意思，你能举一些例子吗？
也许你应该深入研究 Doxygen 手册并手动编辑 doxyfile，它对你来说会更清楚。旁注：当我看到这个时，我很高兴我远离 Cmake，只坚持使用 gnumake！

标签： cmake doxygen

【解决方案1】：

听起来您可能只是将某些文件模式排除在 doxygen 处理之外：

find_package(Doxygen)
if(DOXYGEN_FOUND)
....
set(DOXYGEN_EXCLUDE_PATTERNS */folder_with_clion/* */other_folder/*)
...
endif()

【讨论】：