Ссылка на конкретный метод класса с помощью команды @see с использованием Doxygen

Question

Мне не удалось сослаться на метод определенного класса с помощью команды doxygen @see.

Предположим, у меня есть класс Server с методом start, как показано ниже

@interface Server : NSObject

- (void) start:(NSInteger) mask;

@end

И предположим, у меня есть другой класс, который имеет объект Server.

@interface RandomNumberGeneration

/// How can I reference the method start from 
/// class server using the command @see
/// @see ????
+ (NSInteger) generate;

@end

Итак, есть ли способ сослаться на запуск метода класса Server?

Answer 1

Скопировано с здесь

@ см. Текст | URL | имя класса | classname # methodname Используйте это, чтобы пометить направьте читателя к другому источнику сопутствующей информации.

Итак, я думаю, это должно быть:

/// @see Server#start:

Answer 2

См. Страницу руководства doxygen Автоматическое создание ссылок для получения дополнительной информации о ссылках на классы и функции. В частности, см. Раздел «Ссылки на функции».

Обычно я использую шаблон ссылки на функцию

<className>::<functionName>

Так что в вашем случае я бы использовал

/// \see Server::start

Однако из руководства по доксигену

Для совместимости с JavaDoc можно использовать # вместо a :: в шаблонах выше

как указано в ответе @ PeterG.

Для полноты обратите внимание, что если вы ссылаетесь на члена того же класса

В документации класса, содержащего член foo, ссылка на глобальную переменную делается с использованием ::foo, тогда как #foo будет ссылаться на член.