Doxygen C结构声明,在头文件中没有定义

问题描述 投票:1回答:1

是否可以在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的配置文件,但不会改变情况。

是否可以在Doxygen中添加对已声明但未定义的结构的简短描述?例如,运行doxygen (其中是具有...

c doxygen
1个回答
0
投票

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

/** @struct MyStructure
 * My super secret structure you can't access fields
 */
struct MyStructure;
© www.soinside.com 2019 - 2024. All rights reserved.