doxygen 创建一个索引/链接到子项目的顶级项目答案

【问题标题】：doxygen create a top level project that indexes / links to sub projectsdoxygen 创建一个索引/链接到子项目的顶级项目
【发布时间】：2019-09-17 15:12:45
【问题描述】：

我已经阅读了this 和this，但我仍然不知道该怎么做。

所以我这里有一个虚构的例子（只是为了保持小/简单）：

top_level/
    |
    |--- proj1/
    |      |--- html/
    |
    |--- proj2/
    |      |--- html/

所以这里 proj1 和 proj2 都生成了 html 样式的 doxygen 输出到子文件夹 html/ - 这样每个子文件夹都包含一个 index.html

我现在真正想做的就是创建一个顶级 doxygen 页面，该页面将存在于 top_level/html/ 中，可能也命名为 index.html，指向两个子项目。

这可能吗？我真的在寻找一个具体的例子。

我对标记文件做了一些尝试。我能够为每个子项目生成标签文件（通过设置GENERATE_TAGFILE=html/doxy.tag. 我还将它添加到顶级项目中：TAGFILES=proj1/html/doxy.tag

但我仍然只有一个空的顶级页面:(

【问题讨论】：

使用标签文件可以引用另一个项目的“元素”。因此，在您的顶级部分中，您可以对子包进行描述并参考它们。
@albert 谢谢你。正如我在最后提到的，我试了一下，但它似乎没有用。有没有一个很好的具体例子来说明如何做到这一点？
您是否也尝试过：TAGFILES=proj1/html/doxy.tag:../../proj1/html？一个大的例子（虽然它来自一个实际项目中已经投入了大量时间来完成它）是doc.cgal.org/latest/Manual/packages.html 这里是一个概述（提到的页面），从那里可以转到子包。
@albert 没用，我不明白分号后面的 TAGFILES 的第二部分是什么。那是关于什么的？我尝试了所有相对路径的组合，它只是说它现在找不到这个文件proj1/html/doxy.tag:../../proj1/html。您发送的链接是生成的 doxygen 文件集。我真的需要看看它们是如何创建的（即使用什么 doxygen 配置）。我的标签（原样）被读取正常 - 没有错误 - 但我在文档中没有找到它的链接。我需要在评论中引用它吗？ - 感谢您的支持
抱歉应该是= 符号（请参阅 doxygen 文档，.. 的数量也可能不正确，我是按头做的）。文件 CGAL 代码、文档部分等位于 github 上的 CGAL 存储库中。如前所述，CGAL 结构与 CMake 等相比相当复杂。

标签： linux doxygen

【解决方案1】：

嗯...我有点放弃了标签。

在我的顶级项目中，我创建了一个doxygen.md 文件。我将此添加到INPUTS Doxyfile 标记中。

在那个文件里面是这样的：

@mainpage

 .... some text ...

## Sub Modules
* <a href="../proj1/html/index.html>proj1</a>
* <a href="../proj2/html/index.html>proj1</a>

这比使用标签要简单得多——而且它不需要子文件夹来生成标签——我放弃了这个想法！ :)

【讨论】：