C 如何使用doxygen打印函数文档字符串？

我正在使用doxygen来记录一些C代码。我对doxygen有友好的评论：

/**
 * some comment
 *
 * @param a something
 */

我的目录结构如下所示：

libproject/
    src/
        project.h
        project.c
    docs/
        project.doc.conf
        index.txt
    Makefile

我已经用

doxygen-gproject.doc.conf

生成了

project.doc.conf

，并将

INPUT

标记配置为

INPUT = index.txt ../src/

我还添加了一个虚拟的

index.txt

：

/*! \mainpage My Personal Index Page
 *
 * \section intro_sec Introduction
 *
 * This is the introduction.
 *
 * \section install_sec Installation
 *
 * \subsection step1 Step 1: Opening the box
 *
 * etc...
 */

用于测试。当我跑步时：

$ doxygen project.doc.conf

我在

libproject/docs/

中得到了两个新文件夹：

html

和

latex

。到目前为止，一切顺利

然而，当我在浏览器中导航到

index.html

时，我只得到索引页面和文件列表。我可以浏览源代码，但缺少文档

---

文件在哪里？我必须为doxygen指定一些标记才能绘制它吗？

您必须使用以下方法记录每个文件：

/**
 * @file  project.h
 * @brief some brief description
 */