objective-c - 在没有 Doxygen/编译器警告的情况下记录继承的 Obj-C 方法？

Question

背景:

我正在 Objective-C 中创建复合字典数据结构的层次结构，并且继承自 NSMutableDictionary所以这些类可以在任何需要 NSDictionary/NSMutableDictionary 的地方使用。 (只是为了让人们不认为我在重新发明轮子，每个人都使用 CFMutableDictionaryRef ，加上一些额外的结构，这些结构按排序顺序、插入顺序等存储键)为了与 Apple 的文档保持一致，我已经覆盖了必要的 NSDictionary primitives和 NSMutableDictionary primitives这些类中的所有其他方法都使用它。

目标:

由于我努力尽可能完整地记录我的框架的 API，所以我想要 documentation for my custom subclasses (由 Doxygen 生成)包含 NS(Mutable)Dictionary 最常用方法的描述，因此用户不必查看另一个页面只是为了特定自定义词典继承的方法不变。此外，有时文档必须反射(reflect)由覆盖的原始方法引起的不同功能，尽管方法实现与 NS(Mutable)Dictionary 没有变化。

问题:

当仅记录覆盖的方法时，我没有收到任何错误/警告。如果我添加记录继承方法的注释，Doxygen 会提示(并且不会生成所述文档)，除非我将方法原型(prototype)添加到头文件中。如果我添加原型(prototype)，编译器会发出实现已完成的警告，因为它不包含已声明方法的方法定义。显然，这是一种方法存在于父类中的情况，但编译器在实现它方面坚持不懈，因为原型(prototype)实际上是在子类中重新声明的。

问题:

• 是否可以让 Xcode/gcc 抑制从父类继承的方法的“未找到‘X’的方法定义”警告？
• 是否可以强制 Doxygen 为不存在声明的方法创建文档？我尝试使用 \fn 命令，但得到了相同的结果。
• 是否有可能让 Doxygen 认为我写的文档实际上适用于 NSMutableDictionary，但它是否出现在我所有的自定义子类中？

编辑:

据我所知，第一个问题的答案是肯定和否定。从技术上讲，使用 -Wno-protocol option (或取消选中 Xcode build设置中的“不完整的 Objective-C 协议(protocol)”警告)确实导致 GCC 抑制有关似乎未实现所有协议(protocol)方法的类的编译时警告。然而，这掩盖了那些真正不实现所有必要方法的类的问题。对于构建一个大量使用协议(protocol)的框架，这确实不是一个选择。目前，GCC 似乎不知道从链接(非源)父类继承的方法。

Answer 1

据我所知，你的三个问题的答案是:不是。

我想提请您注意 Apple 文档不会在子类文档中记录继承的方法。

此外，NSDictionary 和 NSMutableDictionary 并不少见，需要提醒它们最常用的方法。对我来说，您已有的现有文档的链接就足够了。

关于您的子类中这些常用方法的特定行为的观点，我只想在详细说明一章中插入一个专门的部分。

无论如何，一种可能的解决方法是同时提供继承方法的声明和实现。但仅出于文档目的，这有点矫枉过正:

- (NSArray *) allValues
{
    return [super allValues];
}