डॉक्सीजन निजी फ़ंक्शन

Question

क्या डॉक्सिजन व्यक्तिगत निजी कार्यों के लिए दस्तावेज़ दिखाने का कोई तरीका है? मैं डॉक्सिजन को निजी कार्यों के विशाल बहुमत के लिए दस्तावेज़ीकरण नहीं दिखाना चाहता हूं लेकिन इसे कुछ चुनिंदा कुछ निजी कार्यों के लिए दिखाता हूं। मेरी प्रेरणा यह है कि इन सी ++ निजी कार्यों को पायथन को विस्तार के रूप में प्रदान किया जाता है और मैं उनके दस्तावेज़ों को डॉक्सीजन में दिखाना चाहता हूं। हालांकि, मैं नहीं चाहता कि वे सार्वजनिक हों क्योंकि उन्हें केवल कक्षाओं की आवश्यकता होती है; वे निश्चित रूप से निजी क्षेत्र में हैं।

धन्यवाद

Answer 1

इसे प्राप्त करने के कुछ तरीके हैं।

आप उन कार्यों को दस्तावेज नहीं कर सकते जिन्हें आप दृश्यमान नहीं दिखाना चाहते हैं। डिफ़ॉल्ट रूप से, डॉक्सिजन उन सदस्यों को नहीं दिखाएगा जिन्हें आपने दस्तावेज़ नहीं दिया था। इस प्रकार, आप इसे निजी दिखाने के लिए कह सकते हैं और किसी भी अनियंत्रित निजी सदस्यों को नहीं दिखाया जाएगा।

Answer 2

\ cond और \ endcond कमांड के बीच अनुभाग को इसके अनुभाग लेबल को ENABLED_SECTIONS कॉन्फ़िगरेशन विकल्प में जोड़कर शामिल किया जा सकता है। यदि सेक्शन लेबल छोड़ा गया है, तो अनुभाग को बिना शर्त प्रक्रिया से बाहर रखा जाएगा।

/** An interface */ 
class Intf 
{ 
    public: 
    /** A method */ 
    virtual void func() = 0; 

    /// @cond COND1 

    /** A method used for testing */ 
    virtual void test() = 0; 

    /// @endcond 
}; 

cond help

नहीं COND1 वर्गों को देखने के लिए देखें: बस ENABLED_SECTIONS विन्यास विकल्प के लिए इसे जोड़ने नहीं है।