2013-06-07 7 views
10

पर synopsis छोड़ दें मैं अनियंत्रित सदस्य फ़ंक्शंस के बारे में डॉक्सिजन चेतावनियों को दबाने का एक तरीका ढूंढ रहा हूं, लेकिन //! @cond और //! @endcond का उपयोग किए बिना, इसलिए सदस्य कार्य अभी भी सारांश के सारांश में दिखाई देते हैं कक्षा। निम्नलिखित की तरह कुछ:अनियंत्रित सदस्य फ़ंक्शन के लिए डॉक्सिजन चेतावनी को दबाएं, लेकिन

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

ये सदस्य कार्यों स्पष्ट काम करते हैं और प्रलेखन की जरूरत नहीं है, लेकिन मैं अब भी उन्हें दस्तावेज़ों में उपलब्ध सदस्य कार्यों की सूची में प्रकट करना चाहते हैं (क्योंकि जानते हुए भी एक वर्ग है कि प्रतिलिपि/असाइन करने योग्य मामलों)। जैसा कि, डॉक्सिजन इनमें से प्रत्येक के लिए "दस्तावेज नहीं" चेतावनी उत्सर्जित करता है। अगर मैं //! @cond और //! @endcond का उपयोग करता हूं, तो दस्तावेज़ पूरी तरह से प्रलेखन से गायब हो जाते हैं। दस्तावेज में दिखाई देने के तरीकों के लिए मुझे क्या चाहिए, लेकिन बिना किसी टिप्पणी के, और मैं ऑक्सीजन को उनके बारे में शिकायत नहीं करना चाहता हूं कि वे अनियंत्रित हैं।

क्या दस्तावेज़ की कमी के बारे में बंद करने के लिए डॉक्सिजन को बताने के लिए कुछ प्रकार की "डमी टिप्पणी" है, लेकिन फिर भी दस्तावेज़ीकरण में विधियों को संरक्षित करते हैं, इसलिए वे दिखाई दे रहे हैं?

+0

कॉन्फ़िगरेशन चर ['WARN_IF_UNDOCUMENTED'] (http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_warn_if_undocumented) क्या आप ढूंढ रहे हैं? इसे 'NO' पर सेट करें और Doxygen इन चेतावनियों को जारी नहीं करेगा। आपको '' EXTRACT_ALL'] (http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_all) को 'YES' पर सेट करने की भी आवश्यकता हो सकती है। – Chris

+1

यह काफी नहीं है जो मैं बाद में हूं। मैं केवल कुछ तरीकों के लिए चेतावनी दबाना चाहता हूं, लेकिन अन्य अनियंत्रित तरीकों के लिए चेतावनी रखना चाहता हूं। संक्षेप में, मैं क्या चाहता हूं जैसे // //! @ अबर्न' और '//! @ Endnowarn'। इस तरह, मैं बहुत सारी चेतावनियों के बिना एक मूक निर्माण कर सकता था, लेकिन फिर भी उन तरीकों से सतर्क हो जाता है जिन्हें दस्तावेज किया जाना चाहिए लेकिन नहीं। –

उत्तर

7

आपको केवल ब्रैकेट जोड़ने की आवश्यकता है। यह मेरे लिए काम करता है:

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

कोई चेतावनी नहीं है और यह अभी भी आउटपुट में दिखाई देती है। यदि आप चाहें तो आप इस कमेंट को \nowarn और \endnowarn पर उपनाम कर सकते हैं।

+0

शानदार, धन्यवाद! –

+0

बढ़िया! यह प्रतिभा है। –

संबंधित मुद्दे