尝试将多个 README.md 文件合并到 Doxygen 转储中

Question

我没有看到上面的答案，所以这是我的问题：

我有一组项目。它们被表示为嵌套的 Git 子模块，像这样：

MAIN-PROJECT
    LIBRARY-1
        LIBRARY-2
            ETC.

每个子模块都有一个 README.md 文件和 CHANGELOG.md 文件（标准 Git 集线器模型）：

MAIN-PROJECT
    README.md
    CHANGELOG.md
    LIBRARY-1
        README.md
        CHANGELOG.md
        LIBRARY-2
            README.md
            CHANGELOG.md
            ETC.

我想做的是使用 "Root" 自述文件作为转储中的主页，但仍呈现内部自述文件，因为每个自述文件都有很好的信息。

我不想单独构建每个 Doxygen 转储。我想要一个从 "Root." 开始的单一整体转储，这是因为我想要类和诸如 link.

之类的东西

有办法吗？我尝试明确指定 "Root" 自述文件，但看起来您只能提供文件名，而不能提供路径。这意味着每个 README 都被考虑用于 post，而获胜的是 "deepest"。

Answer 1

为了能够使用多个 'README.md' 文件，需要考虑以下几点：

使用USE_MDFILE_AS_MAINPAGE时用相对路径指定主README.md。
或者在 master 'README.md'

\mainpage

在另一个 'README.md' 中使用 \page 以便区分不同的文件。

另请注意 \subpage 和 \ref 引用其他页面的可能性

尝试将多个 README.md 文件合并到 Doxygen 转储中

Trying to Incorporate Multiple README.md Files Into A Doxygen Dump

markdown

documentation

doxygen

readme