Question

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

/**
 * 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.doxygen.nl/manual/docblocks.html#structuralcommands

如何使用doxygen打印我的函数doc字符串？

1 个答案: