使用 Doxygen，如何生成一个包含指向我项目中所有 .dox 文件的子页面链接的页面？

Question

我有一个只包含主页链接的 \mainpage。 但是，我希望在最终输出文档中有一个页面，其中包含指向 .dox 文件的所有页面链接。

我知道这可以使用外部脚本来解析 .dox 文件并聚合所有页面变量名称。但是是否有一个配置字段可以为我做到这一点？

Answer 1

您可以使用 xrefitem + 别名来做一些可能完成您正在寻找的事情。

如果您不熟悉外部物品以及可以使用它创建的列表，那么这里有一个参考：http://www.doxygen.nl/manual/commands.html#cmdxrefitem

所以，如果您要在 Doxyfile 中添加以下行

ALIASES += page_list{3} =  "\xrefitem page_list \"\" \"List of Secondary Pages\" \3 \page \1 \2 "

然后您可以将使用 \page 命令的每个位置替换为

\page_list{page_name, Page Title, Some brief description}

现在，在每个页面的顶部，您会看到一个 :（超链接到页面列表）和简要说明。您可以将 {3} 更改为 {2} 并在命令中删除 \2，您将不再在每页顶部看到该简要说明，但您也将不再在列表中看到简要说明。

我不知道如何禁止显示 :。根据 \xrefitem

上的文档

In case parameter "(heading)" is the empty string no heading is generated

但无论如何，我希望这能让你更接近一点。