使用Doxygen，如何生成一个页面，该页面包含指向我项目中所有.dox文件的子页面链接？ [英] With Doxygen, how to generate a page that contains subpage links to all the .dox files in my project?

问题描述

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

I have a \mainpage that contains only the main page links. However, I'd like to have a page in the final output documentation that contains all the page links to the .dox files.

我知道这可以可以使用外部脚本来解析.dox文件并聚合所有页面变量名称。

I know this can be done using external scripts to parse the .dox files and aggregate all the page variable names. But is there a configuration field that does this for me?

推荐答案

您可以使用xrefitem +别名来完成可能会完成哪些任务的配置字段？

You can use xrefitem + aliases to do something that might accomplish what you're looking for.

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

If you are not familiar with xrefitem and the lists you can create with it, then here is a reference: http://www.doxygen.nl/manual/commands.html#cmdxrefitem

因此，如果要将以下行添加到Doxyfile

So, if you were to add the following line to your Doxyfile

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

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

You could then replace every place you use the \page command with

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

现在在每个页面的顶部，您都会看到一个:（超链接到页面列表）和简短的说明。药水。您可以将{3}更改为{2}并在命令中放置\2，并且在每个页面的顶部都将不再看到该简短描述，但是在列表中也将不再获得简短描述。

Now on the top of every page you will see a : (which hyperlinks to the page list) and the brief description. You can change the {3} to {2} and drop the \2 in the command and you will no longer see that brief description on the top of each page, but you will no longer get a brief description in your list either.

我不知道如何禁止显示：。根据关于\xrefitem

I don't know how to suppress displaying the :. According to the documentation on \xrefitem

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

但是无论如何，我希望这能使您更近一些。

But anyway, I hope this gets you a little closer.

这篇关于使用Doxygen，如何生成一个页面，该页面包含指向我项目中所有.dox文件的子页面链接？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！