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

【问题标题】：How do I print my functions doc strings with doxygen?如何使用 doxygen 打印我的函数文档字符串？
【发布时间】：2013-11-21 15:04:38
【问题描述】：

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

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

我的目录结构如下：

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

我已经使用doxygen -g project.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 指定一些标签才能绘制它？

【问题讨论】：

标签： c doxygen

【解决方案1】：

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

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

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

【讨论】：