Ngăn chặn cảnh báo doxygen cho chức năng thành viên không có giấy tờ, nhưng để lại tóm tắt tại chỗ

Question

Tôi đang tìm cách ngăn chặn cảnh báo doxygen về các chức năng thành viên không có giấy tờ, nhưng không sử dụng //! @cond và //! @endcond, vì vậy các chức năng thành viên vẫn xuất hiện trong tóm tắt của lớp học. Một cái gì đó như sau:

class Foo 
{ 
public: 
    Foo(); 
    Foo(const Foo&); 
    Foo& operator=(const Foo&); 
}; 

Những chức năng thành viên làm điều hiển nhiên và không cần tài liệu hướng dẫn, nhưng tôi vẫn muốn chúng xuất hiện trong danh sách các hàm thành viên có sẵn trong tài liệu (vì biết rằng một lớp là các vấn đề có thể sao chép/chuyển nhượng). Như vậy, doxygen phát ra một cảnh báo "không được ghi lại" cho mỗi loại. Nếu tôi sử dụng //! @cond và //! @endcond, các phương pháp sẽ biến mất hoàn toàn khỏi tài liệu. Những gì tôi muốn là cho các phương pháp vẫn còn có thể nhìn thấy trong tài liệu, nhưng không có bất kỳ ý kiến ​​thêm, và tôi muốn oxy không phàn nàn về họ là không có giấy tờ.

Có một số loại "nhận xét giả" để nói với doxygen tắt máy về việc thiếu tài liệu, nhưng vẫn giữ nguyên các phương pháp trong tài liệu, để chúng hiển thị?

Answer 1

Bạn chỉ cần thêm dấu ngoặc vuông. Điều này phù hợp với tôi:

//! \{ 
const int myVar3 = 3; 
const int myVar4 = 3; 
//! \} 

Không có cảnh báo và nó vẫn xuất hiện ở đầu ra. Bạn có thể đặt bí danh số này là \nowarn và \endnowarn nếu bạn muốn.