विशिष्ट डॉक्सीजन चेतावनियों को दबाएं

Question

ऐसा लगता है कि दूसरों ने पहले इस प्रश्न से पूछा है। बस जांचना और देखना था कि कोई जवाब मिला है या नहीं।

मेरे पास निम्न स्थितियों की कई घटनाएं हैं: क्योंकि मैं विभिन्न कार्यों को दस्तावेज कर रहा हूं, कभी-कभी मैं उस स्थिति में भाग लेता हूं जहां मैं कुछ फ़ंक्शन पैरामीटर दस्तावेज करना चाहता हूं लेकिन दूसरों को नहीं। उदाहरण के लिए,

/** 
* 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 
} 

Doxygen प्रलेखन के लिए self_explanatory पैरामीटर शामिल करना और अव्यवस्था कहते हैं, तो मैं बल्कि यह बाहर छोड़ चाहते हैं। हालांकि, डॉक्सिजन चेतावनी देता है कि पैरामीटर अनियंत्रित है। मैं एक्लोक्स का उपयोग कर रहा हूं, और यह चेतावनी देता है कि चेतावनी का एक समूह है जिस पर मुझे परवाह नहीं है।

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

चेतावनी अभी भी उत्पन्न कर रहे हैं:

अभी, मेरी doxyfile निम्न विकल्प सेट है।

एक विकल्प अपमानजनक कोड के आसपास @cond और @endcond जोड़ने के लिए है, लेकिन तब मेरे फ़ंक्शन के लिए कोई भी दस्तावेज़ उत्पन्न नहीं होता है। मैं प्रलेखन चाहता हूं, सिर्फ चेतावनी नहीं।

मैं क्या देख रहा हूँ कुछ की तरह

/** @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 
} 

ताकि चेतावनी संलग्न कोड ब्लॉक में उत्पन्न नहीं कर रहे हैं है ... ...।

अन्य अतः सवाल मैंने पाया:
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

बस self_explanatory पैरामीटर दस्तावेज़, या मन कि चेतावनी सिर्फ हैं कि रखें: चेतावनी। सभी डॉक्सिजन आपको बता रहा है कि ऐसा कुछ है जिसे आपने अनदेखा कर दिया हो।

आप चेतावनी ले सकते हैं या इसे अनदेखा कर सकते हैं। यदि आप वास्तव में उस चेतावनी को दबाना चाहते हैं, तो हो सकता है कि आप अपने पहले लिंक को देखना चाहें। विशेष रूप से, https://stackoverflow.com/a/25137529/3121160।