Ngăn chặn Cảnh báo Doxygen Cụ thể

Question

Có vẻ như những người khác đã hỏi câu hỏi này trước đây. Chỉ muốn kiểm tra xem liệu câu trả lời đã được tìm thấy chưa.

Tôi có một vài lần xuất hiện trong trường hợp sau: khi tôi ghi lại các chức năng khác nhau, đôi khi tôi chạy vào tình huống mà tôi muốn ghi lại một số tham số chức năng chứ không phải các thông số khác. Ví dụ,

/** 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

Thêm self_explanatory tham số để các tài liệu Doxygen chỉ thêm lộn xộn, vì vậy tôi thà để nó ra. Tuy nhiên, Doxygen cảnh báo rằng tham số là không có giấy tờ. Tôi đang sử dụng Eclox, và thật khó chịu khi có một loạt các cảnh báo được nêu bật mà tôi không quan tâm.

Ngay bây giờ, doxyfile tôi có các tùy chọn sau đây thiết lập:

EXTRACT_ALL   = YES 
WARNINGS    = YES 
WARN_IF_UNDOCUMENTED = NO 
WARN_IF_DOC_ERROR = YES 
WARN_NO_PARAM_DOC = NO 

Những cảnh báo vẫn đang được tạo ra.

Một tùy chọn là thêm @cond và @endcond xung quanh mã vi phạm, nhưng sau đó không có tài liệu nào được tạo cho (các) hàm của tôi. Tôi muốn tài liệu, không phải là cảnh báo.

Những gì tôi đang tìm kiếm là một cái gì đó giống như ...

/** @nowarn 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
* @endnowarn 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

... để cảnh báo không được tạo ra trong khối mã kèm theo.

SO câu hỏi khác tôi đã tìm thấy:
Suppressing Doxygen warnings
Suppress doxygen warning for undocumented member function, but leave synopsis in place
Is it possible to choose which Doxygen warning to show?

Answer 1

Chỉ cần ghi lại các thông số self_explanatory, hoặc ghi nhớ rằng cảnh báo chỉ rằng: cảnh báo. Tất cả Doxygen đang nói với bạn là có điều gì đó bạn có thể đã bỏ qua.

Bạn có thể nhận cảnh báo hoặc bỏ qua nó. Nếu bạn thực sự muốn chặn cảnh báo đó, bạn có thể muốn tìm trong chuỗi đầu tiên bạn đã liên kết. Cụ thể, https://stackoverflow.com/a/25137529/3121160.