在Doxygen中注释文件

Question

我有一个C标头，我想为其写一个介绍性注释。像这样：

/**
 * @brief Provides stuff for my great program.
 */

#ifndef MYHEADER_H
#define MYHEADER_H

#define __USE_GLIBC

#endif

此外，我有这个Doxyfile：

FULL_PATH_NAMES = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
RECURSIVE = YES
INPUT = .
EXTRACT_ALL = YES
QUIET = YES
EXTRACT_STATIC = YES

[当我现在运行Doxygen时，它会生成HTML和LaTeX文档，但是简短的描述最终只是记录了宏而不是整个文件。

那么如何为Doxygen提供文件的简短描述？

Answer 1

您应该使用@file宏来表示与整个文件有关的此注释：

/**
 * @file myheader.h
 * @brief Provides stuff for my great program.
 */

Answer 2

假设您的文件名为header.h。这样做：

/*! @file header.h
 *  @brief Provides stuff for my great program.
 *
 *  Detailed description here, if any.
 */

Answer 3

虽然根据@file myfile.ext，使用the docs可以在任何文件中使用（即，不只是文档注释所在的文件），但仅执行@file即可记录当前文件。

完整示例

/**
 * @file
 * @brief A file that is documented.
 *
 * Detailed description, etc.
 */