Referenzieren einer bestimmten Klassenmethode mit @see-Befehl unter Verwendung von Doxygen

Question

Ich konnte mit dem Befehl doxygen @see nicht auf eine bestimmte Klassenmethode verweisen.

Angenommen, ich habe eine Klasse-Server mit einer Methode starten wie unter

@interface Server : NSObject 

- (void) start:(NSInteger) mask; 

@end 

Und wenn ich eine andere Klasse, die ein Objekt von Server hat.

@interface RandomNumberGeneration 

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

@end 

So ist es eine Möglichkeit, die Methode Start der Klasse Server zu verweisen?

Answer 1

Kopiert von here

@see Text | URL | Klassenname | Klassenname # Methodenname Verwenden Sie dies, um zu zu kennzeichnen, verweisen Sie den Leser auf eine andere Quelle verwandter Information.

Also ich denke, es sein sollte:

/// @see Server#start: 

Answer 2

die doxygen Handbuch Seite Automatic link generation Weitere Informationen zur Referenzierung Klassen und Funktionen Siehe. Beachten Sie insbesondere den Abschnitt "Verknüpfungen zu Funktionen".

Normalerweise verwende ich die Funktion refernce Muster

<className>::<functionName> 

Also in Ihrem Fall würde ich

/// \see Server::start 

jedoch vom doxygen Handbuch

Für JavaDoc Kompatibilität a verwenden # kann anstelle von :: in den obigen Mustern verwendet werden

wie in @ PeterG.'s Antwort angegeben.

Der Vollständigkeit halber ist zu beachten, dass, wenn Sie eine Referenz ein Mitglied in der gleichen Klasse

In der Dokumentation einer Klasse ein Mitglied foo, einen Verweis auf eine globale Variable enthält ::foo gemacht verwendet, während #foo wird Link zum Mitglied