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

2019年8月1日 244次阅读

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

BOOL myFunc(void);

然后我在.m中实现了.

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

最佳答案 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安装文件中.

点赞