Odsyłacz do konkretnej metody klasy z poleceniem @see przy użyciu Doxygen

Question

Nie mogłem odwołać się do konkretnej metody klasy za pomocą polecenia doxygen @see.

Załóżmy, że mam klasy serwera z metodą rozpocząć jak poniżej

@interface Server : NSObject 

- (void) start:(NSInteger) mask; 

@end 

I Załóżmy, że mam inną klasę, która posiada przedmiot Server.

@interface RandomNumberGeneration 

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

@end 

Czy istnieje sposób na odniesienie do metody rozpoczęcia klasy Server?

Answer 1

Skopiowane z here

@see tekst | URL | classname | classname # methodname Użyj tego do oznaczenia jako odsyłaj czytelnika do innego źródła powiązanych informacji.

Więc myślę, że powinno być:

/// @see Server#start: 

Answer 2

Zobacz doxygen stronę podręcznika Automatic link generation Więcej informacji o przedstawieniu klas i funkcje. W szczególności zobacz sekcję "Łącza do funkcji".

Zazwyczaj używam wzorzec funkcja refernce

<className>::<functionName> 

Więc w twoim przypadku użyłbym

/// \see Server::start 

Jednak z instrukcji doxygen

Dla kompatybilności JavaDoc A # może być użyte zamiast :: w wzorach powyżej

zgodnie z odpowiedzią @ PeterG.

Dla uzupełnienia należy pamiętać, że jeśli odniesienie członkiem w tej samej klasie

w dokumentacji klasy zawierającej foo użytkownika, odniesienie do zmiennej globalnej jest wykonany przy użyciu ::foo, natomiast #foo będzie link do członka.