Как получить Doxygen для ссылки на метод класса Objective-C? - PullRequest
8 голосов
/ 25 февраля 2011

Я использую Doxygen для документирования своего кода Objective-C, и пока он работает нормально.

Однако я искал несколько часов и не смог найти какой-либо способ связатьк методу.Например:

@interface Example : NSObject {
}

/** This is an example method I want to link to. */
- (void)methodWithArgument:(NSString*)one andArgument:(NSString*)two;

/** I want a link to methodWithArgument:andArgument: but Doxygen
 *  doesn't seem to link the two.
 */
- (void)someOtherMethod;

@end

Я ожидаю, что methodWithArgument: andArgument: станет ссылкой на соответствующий метод, но в сгенерированной документации это просто текст.

Я перепробовал множество других форм:

methodWithArgument:andArgument:
-methodWithArgument:andArgument:
::methodWithArgument:andArgument:
Example::methodWithArgument:andArgument:

Но, похоже, ни одна из них не работает.Можно ли связать методы Objective-C в Doxygen, и если да, то как?Кроме того, как я могу связать с методом другого класса?Я знаю, как сделать это для C, C ++ и Java, но для Objective-C ответ ускользает от меня.Может ли быть так, что Doxygen просто не поддерживает методы связывания в Objective-C?Это выглядит как недостаток ...

1 Ответ

8 голосов
/ 25 февраля 2011

Вы сказали, что пробовали это, но у меня работает в Doxygen 1.7.2:

/** I want a link to Example::methodWithArgument:andArgument: but Doxygen
 *  doesn't seem to link the two.
 */

Это может зависеть от вашего файла конфигурации; Я использовал файл конфигурации по умолчанию, сгенерированный doxygen -s -g Doxyfile.

...