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

Question

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

我有一组项目。它们表示为嵌套的 Git 子模块，如下所示：

MAIN-PROJECT
    LIBRARY-1
        LIBRARY-2
            ETC.

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

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

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

我不想单独构建每个 Doxygen 转储。我想要一个从“根”开始的单一的、整体的转储。这是因为我想要类和诸如此类的链接。

有没有办法做到这一点？我尝试明确指定“根”自述文件，但看起来您只能提供文件名，而不是路径。这意味着每个 README 都会被考虑用于发布，并且获胜的是“最深”的。

标签： markdowndocumentationdoxygenreadme

Answer 1

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

• 使用时用相对路径指定主要的 README.md USE_MDFILE_AS_MAINPAGE。
• 或者\mainpage在主 'README.md' 中使用
• 在另一个“README.md”中使用\page，以便区分不同的文件。

\subpage还要注意和\ref参考其他页面的可能性