主页上带有氧气的功能列表

Question

我确定这已经在某个地方被问到了，但是我似乎找不到它，所以就到这里了。

我正在用C创建程序，并使用Doxygen生成文档。我对结果非常满意，但是主页没有内容。我想按字母顺序列出该程序中使用的所有功能和结构的列表。

我对Doxygen的了解不多，除了我用来达到这一目的的简单教程之外。 Doxygen似乎可以完成一项任务，但是到目前为止，我发现的只是关于如何创建自定义主页的说明。

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

Answer 1

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

在此处附上样本：

/**

\mainpage WatchDog

\author User Name <[email protected]>
\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/>
*/