Question

我确定已经在某个地方问了这个问题，但我似乎无法找到它，所以就这样了。

我正在用C创建一个程序并使用Doxygen生成文档。我对结果非常满意，但主页没有内容。我想在主页面上按字母顺序填写程序中使用的所有函数和结构的列表。

我对Doxygen知之甚少，除了我过去使用的简单教程之外。这似乎是Doxygen能够完成的任务，但到目前为止，我发现的是如何创建自定义主页的说明。

是否可以使用Doxygen在主页面上自动生成功能和结构列表？

Answer 1

添加新文件main_page.dox（您也可以使用.txt，.doc或.md）。它应该在您配置的Doxygen目录中。

在此处附上样本：

/**

\mainpage WatchDog

\author User Name <user.name@example.com>
\copyright XYZ Pvt. Ltd.

*/

Doxygen Main Page Setup

Answer 2

我建议你使用@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/>
*/

带有doxygen的主页上的功能列表

2 个答案: