objective-c - Objective-C 项目中的 Doxygen 文档 C 函数

Question

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

BOOL myFunc(void);

然后我在 .m 中实现了它

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

Answer 1

Doxygen 确实记录了直接的 C 函数。

经过更多测试

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

我认为需要将其设置为与默认值相反，这可能是一个错误。

如果绝望，请在问题中发布设置。我刚刚从头开始创建了一个示例，并验证了当我使用 EXTRACT_ALL 时您的函数使用 Doxygen 显示，但如果我关闭它，则没有文件成员部分。

您应该在文件 - 文件成员下看到函数，如 seen here在 VTK 文档中。

抱歉，我没有早点拿起它，但我一直在使用 EXTRACT_ALL，因为我正在处理遗留代码库，其中大多数函数都缺少特殊注释。

较早的想法尝试在文件顶部添加@file 注释以查看是否正在处理。

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

我敢打赌，您的文件扩展名或目录未包含在您正在运行的 doxygen 安装文件中。