如何用doxygen打印我的函数文档字符串？

Question

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

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

和我的目录结构是这样的：

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

我已经产生project.doc.conf与doxygen -g 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的一些标签来绘制它吗？

Answer 1

必须使用文档的每个文件：

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

http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands