在 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

当在任何文件中使用@file myfile.ext作品时（即不仅仅是文档注释所在的文件），根据docs，这样做只会@file记录当前文件。

完整示例

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