2010-10-22 5 views
6

मैं एक उपरोक्त विधि या उप वर्ग की एक लागू वर्चुअल विधि कैसे दस्तावेज कर सकता हूं? क्या मुझे @copydoc का उपयोग करना चाहिए?Doxygens @copydoc के बिना ओवरराइड/कार्यान्वित फ़ंक्शंस को कैसे दस्तावेज़ित करें?

class A { 
    /** 
    * A detailed description........ 
    */ 
    virtual int foo(int i); 
} 

class B : public A { 
    /** {I won't write the same description again.} */ 
    int foo(int i); 
} 

उत्तर

5

यदि विधि ओवरराइड है तो संभवत: उपclass कार्यान्वयन से अलग व्यवहार होता है। उस स्थिति में आपको उस विधि के लिए दस्तावेज़ को फिर से लिखना चाहिए।

यदि आप समान दस्तावेज चाहते हैं, तो आप INHERIT_DOCS विकल्प का उपयोग कर सकते हैं।

+0

ओह, असल में मेरा मतलब विशेष रूप से लागू वर्चुअल फ़ंक्शंस के लिए है। – elgcom

+0

@elgcom: मेरा जवाब संपादित किया। आशा करता हूँ की ये काम करेगा। –

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

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