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

Question

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

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

Answer 1

您可以使用xrefitem +别名来执行可能完成您正在寻找的内容。

如果您不熟悉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，您将不再在每个页面的顶部看到该简要说明，但您将不再在列表中获得简要说明。< / p>

我不知道如何压制显示：。根据\ xrefitem

上的文档

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

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