Doxygen 不为全局函数生成文档答案

【问题标题】：Doxygen not generating doc for global functionsDoxygen 不为全局函数生成文档
【发布时间】：2014-02-25 11:01:14
【问题描述】：

我有一个 C 头文件，其中声明了许多方法，它们都包含有效的 doxygen 标记来生成文档，但是 doxygen 无法为这些方法创建任何文档，除非我将 EXTRACT_ALL 设置为 true，但是即使在这种情况下，这些方法也只出现在头文件的文档中......我想要一个收集点“Functions”，它会有一个方法列表，我可以在其中点击它们......这可能吗? （我的输出已针对 C/PHP 进行了优化，但是将其设置为其他内容根本没有帮助）...

【问题讨论】：

标签： c doxygen documentation-generation

【解决方案1】：

如果您想为全局函数生成文档，则必须记录该文件。这是一个例子：

/**
 * @file buffer.h
 *
 * Interfaces to Data Buffer.
 *
 * This header define the interfaces of general purpose dynamic data buffer that
 * implemented by Equinox.
 */
#ifndef _EQUINOX_BUFFER_H
#define _EQUINOX_BUFFER_H

【讨论】：

最好把文件名去掉。如果省略文件名，则假定文件名。如果头文件的名称发生变化，它也避免了更新名称的需要。