c - 头文件中没有定义的 Doxygen C 结构声明

Question

是否可以在 Doxygen 中添加对已声明但未定义的结构的简要描述？例如，运行 doxygen <config file> (其中 <config file> 是具有默认参数的配置文件)在包含文件 mydefinition.h 的文件夹中

#ifndef MYDEFINITION_H_
#define MYDEFINITION_H_

/** My super secret structure you can't access fields */
struct MyStructure;

/** The function that lets you use any instance of 'struct MyStructure'
 * @param msobj the object
 */
void functionUsingMyStructure(struct MyStructure* msobj);

将生成函数的文档，但不会结构的文档。

我试图通过设置 OPTIMIZE_OUTPUT_FOR_C = YES 来修改 Doxygen 的配置文件但这并没有改变这种情况。

Answer 1

Doxygen 忽略结构的前向声明。要解决此问题，您必须明确声明给定的注释 block 描述了您的结构。

/** @struct MyStructure
 * My super secret structure you can't access fields
 */
struct MyStructure;