Doxygen 不为全局函数生成文档

Fer*_*eak 5 c doxygen documentation-generation

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

Ult*_*pon 5

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

/**
 * @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
Run Code Online (Sandbox Code Playgroud)

  • 最好保留文件名。如果省略文件名,则假定文件名。它还避免了在头文件名称更改时更新名称的需要。 (2认同)