代码之家 › 专栏 › 技术社区 › Justin Meiners

Doxygen文档C在Objective-C项目中的功能

doxygen documentation objective-c

Justin Meiners · 技术社区 · 14 年前

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

BOOL myFunc(void);

我已经在上午实现了。

Doxygen是否在Objective-C中检测不到直C功能,或者是否有必须打开的选项?Doxygen的函数定义是否错误?

1 回复 | 直到 9 年前

Andy Dent 14 年前

经过更多的测试

使用Doxywizard并在专家模式下检查值—当您将鼠标移到对象上时,它提供了一些很好的帮助。特别是,您应该更改默认值,以便

我认为需要设置这个,与默认相反,可能是一个bug。

如果不顾一切,在问题中张贴设置。我刚刚从头创建了一个示例,并验证了当我使用EXTRACT\u ALL时,您的函数是使用Doxygen显示的,但是如果我关闭它,就没有文件成员部分。

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

很抱歉,我没有早些时候拿起它,但我一直都在提取所有的,因为我对遗留代码的基础上,大多数功能缺乏特别的意见工作。

尝试在文件顶部添加@file注释,以查看是否正在处理该注释。

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

推荐文章

Alvaromon · 如何使用ReSharper获取C#样式的三斜杠注释++

6 年前

Shepmaster Lukas Kalbertodt · 如何基于功能标志有条件地执行模块级doctest?

6 年前

depaulagu · react本机文档是如何制作的?

6 年前

yearntolearn · R包命名空间

6 年前

Jean-Baptiste Yunès · 如何在XCode中记录Swift函数的参数标签和非参数名称?

6 年前

Dimebag · dict的Python NumPy风格文档

6 年前

m00am · 如何对使用板条箱特性的函数进行doctest?

6 年前

zython Hiery Nomus · Aiohttp errno代码文档?Errno-2/111/113/104/101[关闭]

7 年前

userMod2 · 节点-遍历JS文件的文件夹并提取某些位[关闭]

7 年前

ian · ri中记录的关键字方法参数在哪里?[已关闭]

7 年前