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忽略结构的前向声明。要解决此问题，您必须明确声明给定的注释块描述了您的结构。

+minute1