Referencia a un método de clase específico con el comando @see utilizando Doxygen

Question

No pude hacer referencia a un método de clase específico utilizando el comando doxygen @see.

Supongamos que tengo un servidor de clase con un método de arranque, como a continuación

@interface Server : NSObject 

- (void) start:(NSInteger) mask; 

@end 

Y supongamos que tengo otra clase que tiene un objeto de servidor.

@interface RandomNumberGeneration 

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

@end 

Entonces, ¿hay alguna manera de hacer referencia al método start de la clase Server?

Answer 1

Copiado del here

texto @see | URL | nombre de clase | classname # methodname Utilícelo para etiquetar al remitir al lector a alguna otra fuente de información relacionada.

así que supongo que debe ser:

/// @see Server#start: 

Answer 2

Consulte la página del manual doxygen Automatic link generation para obtener más información sobre la referencia a las clases y funciones. En particular, consulte la sección "Enlaces a funciones".

Por lo general, yo uso el patrón de la función refernce

<className>::<functionName> 

Así, en su caso, me gustaría utilizar

/// \see Server::start 

Sin embargo, desde el manual doxygen

Para JavaDoc compatibilidad de una # se puede usar en lugar de a :: en los patrones anteriores

según lo indicado en la respuesta de @ PeterG.

Para completar, tenga en cuenta que si una referencia un miembro de la misma clase

En la documentación de una clase que contiene un foo miembro, una referencia a una variable global se realiza mediante ::foo, mientras que #foo se enlace al miembro.