Tham chiếu một phương thức lớp cụ thể với lệnh @see sử dụng Doxygen

Question

Tôi không thể tham chiếu một phương thức lớp cụ thể bằng cách sử dụng lệnh doxygen @see.

Giả sử tôi có một lớp Server với một phương pháp bắt đầu như dưới đây

@interface Server : NSObject 

- (void) start:(NSInteger) mask; 

@end 

Và giả sử tôi có một lớp học có một đối tượng của Server.

@interface RandomNumberGeneration 

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

@end 

Vì vậy, có cách nào để tham chiếu phương thức khởi động của máy chủ lớp không?

Answer 1

sao chép từ here

văn bản @see | URL | classname | classname # methodname Sử dụng thẻ này để gắn thẻ cho giới thiệu người đọc đến một số nguồn thông tin liên quan khác.

Vì vậy, tôi đoán nó nên là:

/// @see Server#start: 

Answer 2

Xem doxygen thủ công trang Automatic link generation để biết thêm thông tin về tham khảo các lớp học và chức năng. Đặc biệt, xem phần "Liên kết đến chức năng".

Thông thường, tôi sử dụng mô hình chức năng refernce

<className>::<functionName> 

Vì vậy, trong trường hợp của bạn, tôi sẽ sử dụng

/// \see Server::start 

Tuy nhiên, từ hướng dẫn doxygen

Đối javadoc tương thích một # có thể được sử dụng thay vì một :: trong các mẫu ở trên

như đã nêu trong câu trả lời của @ PeterG.

Để hoàn chỉnh, lưu ý rằng nếu quý khách tham khảo một thành viên trong cùng một lớp

Trong tài liệu của một lớp có chứa một foo thành viên, một tham chiếu đến một biến toàn cầu được làm bằng ::foo, trong khi #foo sẽ liên kết với thành viên.