Doxygen Highlight Parameter trong Pre-condition

Question

Tôi có một tiêu đề doxygen cho một chức năng như sau:

/** Some description. 

    @param[in] grid1  First grid 
    @param[in] grid2  Second grid 

    @pre grid1 and grid2 must be of the same dimensions 
*/ 

Tôi muốn grid1 và grid2 được nhấn mạnh đặc biệt trong các điều kiện tiên phần của các tài liệu được tạo ra, vì chúng là các tham số. Trong tâm trí của tôi, tôi sẽ có thể làm điều gì đó như

@pre #grid1 and #grid2 must be the same size 

Nhưng điều này không hiệu quả.

Bất kỳ suy nghĩ nào về cách đạt được điều này?

Cảm ơn!

Answer 1

Sẽ thật tuyệt nếu # tự động được liên kết với định nghĩa đối số hàm. Tuy nhiên, tôi không thể nhìn thấy anyway làm điều này trong phần automatic link generation của sổ tay doxygen.

Sau khi xem nguồn tài liệu HTML, có vẻ như các thông số dường như được tạo kiểu đơn giản là strong và với lớp paramname. Vì vậy, chẳng hạn như

@pre <strong class="paramname">grid1</strong> and 
    <strong class="paramname">grid2</strong> must be the same size. 

sẽ cung cấp cho bạn kết quả mong muốn. Rõ ràng điều này là quá chi tiết để viết ra mỗi lần. Tuy nhiên, bạn sẽ có thể để xác định một custom command, nói \paramname, để làm điều này vì vậy bạn chỉ có thể viết

@pre \paramname{grid1} and \paramname{grid2} must be the same size. 

Sửa: Đây có thể đạt được với các tập tin cấu hình alias

ALIASES += paramname{1}="<strong class="paramname">\1</strong>" 

Answer 2

Landed ở đây tìm kiếm câu trả lời, nhưng tìm thấy nó ở nơi khác.

Sử dụng \p để cho biết từ tiếp theo là tham số chức năng.

Và, tất nhiên, bạn có thể sử dụng @ thay vì \.

/** Some description. 

    @param[in] grid1  First grid 
    @param[in] grid2  Second grid 

    @pre @p grid1 and @p grid2 must be of the same dimensions 
*/ 

Xem Doxygen Special Commands reference.