Doxygen文档C在Objective-C项目中起作用

时间:2010-09-07 23:27:14

标签: objective-c documentation doxygen

我正在使用Objective-C编写项目,我已经开始使用Doxygen自动生成文档。该项目的很大一部分包含基本的C函数。不幸的是,Doxygen不记录C函数,只记录Objective-C类及其方法。我有几个头文件中定义的函数,如下所示:

BOOL myFunc(void);

然后我在.m。

中实现了

Doxygen是否在Objective-C中没有检测到直接的C函数,或者是否有必须打开的选项?我的函数是否为Doxygen定义不正确?

1 个答案:

答案 0 :(得分:2)

Doxygen肯定记录了直接的C函数。

经过更多测试

使用Doxywizard并在专家模式下检查值 - 当您将鼠标悬停在某物上时,它会提供一些很好的帮助。特别是,您应该更改默认值,因此EXTRACT_ALL是 已检查

我认为需要设置它,与默认设置相反,可能是一个错误。

如果绝望,请在问题中发布设置。我刚刚从头开始创建了一个样本并验证了当我使用EXTRACT_ALL时你的函数出现了使用Doxygen但是如果我关闭它就没有File Members部分。

您应该在VTK文档中看到文件 - 文件成员下面的函数seen here

很抱歉,我之前没有提到它,但我一直在使用EXTRACT_ALL,因为我正在使用遗留代码库,大多数函数都缺少特殊注释。

早期想法尝试在文件顶部添加@file注释,看看是否正在处理。

   /// @file fred.h This file defines functions used in fred.m

我敢打赌你的文件扩展名或你的目录不包含在你正在运行的doxygen设置文件中。