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



我在上面没有看到答案,所以我的问题来了:

我有一套项目。它们表示为嵌套的 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.md"文件,需要考虑以下几点:

  • 使用USE_MDFILE_AS_MAINPAGE时指定具有相对路径的主要 README.md。
  • 或者使用主mainpage"README.md">
  • 在其他"README.md"中使用page,以便区分不同的文件。

另请注意subpageref引用其他页面的可能性

最新更新