我确定这已经在某个地方被问过了，但我似乎找不到它，所以就这样吧。
我正在用 C 语言创建一个程序并使用 Doxygen 生成文档。我对结果很满意，但是主页没有内容。我想在主页上按字母顺序列出程序中使用的所有函数和结构的列表。
我对 Doxygen 知之甚少，除了我用来达到这一点的简单教程之外。这似乎是 Doxygen 能够完成的任务，但到目前为止，我发现的只是有关如何创建自定义主页的说明。
是否可以使用 Doxygen 在主页上自动生成函数和结构的列表？
【问题讨论】：
index.html，它将包含Files 作为可切换选项卡之一。转到文件->全局->函数->（从a到z排序的函数列表）
标签： c documentation doxygen
从配置的角度来看，Doxygen 并没有真正提供很多东西。您可以与 Doxygen 和 doxyrest 一起使用名为 Sphinx 的工具。
基本上，您将能够使用 Doxygen 生成XML。 Doxyrest 会将 XML 输出转换为 .rst 文件，而 Sphinx 将处理最终结果（它只处理 .rst，这就是你的原因将需要使用像 doxyrest 这样的中间工具。
Sphinx 将生成漂亮的 HTML 页面，这些页面易于阅读，更重要的是，易于配置。
关于如何组合这三个工具并一起使用的信息可以在这个页面上找到：https://vovkos.github.io/doxyrest/manual/basic.html
解决问题的方法是使用 \addtogroup Doxygen 命令对函数进行分组（将所有函数添加到同一组），然后使用 Sphinx 选择新创建的组页作为索引/登录页.这可以通过编辑 Sphinx 的 conf.py 中的一些行来完成。
【讨论】：
我建议你使用@mainpage。这个函数改变了主页的标题，然后你可以使用像@brief这样的函数来获取简短的信息。
使用 html 标签来创建部分，对我来说它有效。然后在带有函数@see 的新部分中，您可以从主页转到函数或文件。这是一个工作示例：
/**
* @mainpage WATCHDOG
* <hr/>
* @setion <b> File tree<b/>
* @brief Here you can see the main files which are used.
* @see io.c
* @see watchdog.c
* @see watchdog.h
* <p/><br/>
* <hr/>
* In this part we have few main functions used by the programm
* <p/><br/>
* @see watchdog_init_s();
* @see fpga_resetregs_init_s();
* @see watchdog_read(int add, unsigned int ws );
* @see watchdog_reset_io_write(WD * watchdog, unsigned int* data,unsigned int *ws );
* <hr/>
*/
【讨论】：