Fare riferimento a un metodo di classe specifico con il comando @see utilizzando Doxygen

Question

Non è stato possibile fare riferimento a un metodo di classe specifico utilizzando il comando doxygen @see.

Supponiamo che io sono una classe di server con un metodo start come qui di seguito

@interface Server : NSObject 

- (void) start:(NSInteger) mask; 

@end 

E supponiamo ho un'altra classe che ha un oggetto di server.

@interface RandomNumberGeneration 

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

@end 

Quindi, c'è un modo per fare riferimento al metodo di avvio della classe Server?

Answer 1

copiato da here

testo @see | URL | nome di classe | classname # methodname Utilizzare questo per taggare a riferire il lettore ad un'altra fonte di informazioni correlate.

quindi credo che dovrebbe essere:

/// @see Server#start: 

Answer 2

consultare il manuale doxygen pagina Automatic link generation per ulteriori informazioni sul riferimento a classi e funzioni. In particolare vedere la sezione "Collegamenti alle funzioni".

In genere, io uso il modello funzione di riferimento e

<className>::<functionName> 

Quindi nel tuo caso, vorrei usare

/// \see Server::start 

Tuttavia, dal manuale doxygen

Per JavaDoc compatibilità di un # può essere usato al posto di un :: nei modelli sopra

come indicato nella risposta di @ PeterG.

Per completezza, si noti che se un riferimento di un membro della stessa classe

Nella documentazione di una classe che contiene un foo membro, un riferimento a una variabile globale è realizzato con ::foo, mentre #foo sarà link al membro.