क्या Doxygen में एक @inheritDoc समतुल्य है?

Question

मुझे पता है कि जावाडोक {@inheritDoc} संकलित करेगा, लेकिन ऐसा करने के लिए डॉक्सीजन तरीका क्या है?

Answer 1

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

By default, डिफ़ॉल्ट क्लाइंट क्लास से दस्तावेज़ प्राप्त करने के लिए डिफ़ॉल्ट है।

Answer 2

अपने Doxygen विन्यास फाइल में हां में INHERIT_DOCS सेट (जो वास्तव में डिफ़ॉल्ट है) के साथ, बस अपने ओवरराइड सदस्यों पूरी तरह से uncommented छोड़ दो और Doxygen स्वचालित रूप से आधार वर्ग से प्रलेखन डाल देंगे।

@copydoc उस मामले के लिए उपयोगी है जहां आप बेस क्लास टिप्पणियों का उत्तराधिकारी बनाना चाहते हैं, लेकिन फिर कुछ सबक्लास-विशिष्ट विवरण जोड़ें।