2013-09-04 15 views
5

Tôi đang ghi lại một số chức năng với quá tải mẫu và muốn tham chiếu đến quá tải cụ thể. Nhưng tôi không biết chính xác cách gõ chữ ký cho lệnh \ref để hiểu; nó không may đòi hỏi một phiên bản kinh điển và tôi không biết nó. Có cách nào để nhận được danh sách các chữ ký chuẩn doxygen tạo ra không?Tôi làm cách nào để tìm đúng tham chiếu doxygen cho những thứ có chữ ký phức tạp?

trường hợp cụ thể của tôi là chức năng tuyên bố như thế này:

template <typename T, size_t S> 
int function(T value, Table const (&descriptors)[S]); 

Tôi đã thử

\ref function(T,Table(&)[]) 
\ref function<>(T,Table(&)[]) 
\ref function(T,const Table(&)[]) 
\ref function<>(T,const Table(&)[]) 
\ref function(T,Table const(&)[]) 
\ref function<>(T,Table const(&)[]) 

Và tôi đã cố gắng mà không có sự \ref quá (nó là nghĩa vụ phải nhận thấy những biểu tượng tự động), nhưng điều đó không tốt hơn.

Hoặc có cách nào để tự xác định tài liệu tham chiếu theo cách không?

Tôi cũng đã cố gắng xác định neo trong tài liệu hàm đích, nhưng trỏ đến phần mô tả chứ không phải tiêu đề làm tham chiếu đến hàm.

+0

'S' nên là một phần của giải pháp. – Jarod42

Trả lời

2

Một lỗi trong doxygen ngăn chặn @ ref'ing tham số có loại bao gồm niềng răng. Tôi vừa mới committed một giải pháp khả thi cho GitHub. Hãy cho tôi biết nếu điều đó phù hợp với bạn.

tôi đã sử dụng các ví dụ sau đây để kiểm tra nó bản thân mình:

/** @file */ 

/** complex function */ 
template <typename T, size_t S> 
int function(T value, Table const (&descriptors)[S]); 

/** @mainpage 
* See @ref function(T,Table const (&)[S]) "complex function" for details. 
*/ 
Các vấn đề liên quan