Doxygen में शरीर टिप्पणी

मैं कुछ कोड है जो मुझे बहुत पसंद है में शरीर टिप्पणी के साथ दस्तावेज़ करना चाहते हैं:Doxygen में शरीर टिप्पणी

/*! \file best.cpp 
* \brief The best 
* 
* I am the best 
*/ 

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! 
    * Does some more things 
    */ 
    doMoreThings(); 
    /*! 
    * Checks that the things it does are the best 
    */ 
    checkBest(); 
}

लेकिन यह कोड टुकड़ों में अंदर ब्लॉक फ़ॉर्मेट करने के लिए लगता है जब मैं इस पर doxygen चलाने के लिए, जैसे कि @code या \code आदेशों का उपयोग किया गया था (जो वे नहीं थे)। मैं इन-बॉडी टिप्पणियों को सामान्य पाठ की तरह स्वरूपित करना चाहता हूं।

क्या किसी ने इससे पहले सामना किया है? धन्यवाद।

स्रोत

2012-06-25 Andrew Lee

मुझे पूरा यकीन है कि डॉक्सिजन ऐसा नहीं कर सकता है। –

@CatPlusPlus का क्या मतलब है? Doxygen कौन सा हिस्सा नहीं कर सकता है? –

एक डुप्लिकेट की तरह दिखता है [http://stackoverflow.com/questions/758045/how-to-be-able-to-extract-comments-from-inside-a-function-in-doxygen ](http:// stackoverflow.com/questions/758045/how-to-be-able-to-extract-comments-from-inside-a-function-in-doxygen) – ekholm

मैं समस्या को ठीक करने में कामयाब रहा। यह पता चला है कि किसी भी तरह डॉक्सिजन एक दूसरे के संबंध में इंडेंट होने के रूप में उन ब्लॉकों को संसाधित कर रहा था, और मार्कडाउन में इंडेंटेशन (स्टैक ओवरफ्लो पर अधिक) एक कोड ब्लॉक इंगित करता है (http://en.wikipedia.org/wiki/Markdown#Code) । मैंने बस मार्कडाउन बंद कर दिया और इस मुद्दे को ठीक कर दिया।

भविष्य में इस प्रश्न को पढ़ने के लिए, यदि आप अभी भी मार्कडाउन समर्थन चाहते हैं, तो सावधान रहें कि दूसरी पंक्ति पर टिप्पणी ब्लॉक शुरू न करें - तुरंत टिप्पणियां शुरू करें।

इस के लिए मेरी कम से कम उदाहरण बदलना:

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! Does some more things 
    */ 
    doMoreThings(); 
    /*! Checks that the things it does are the best 
    */ 
    checkBest(); 
}

(इन-शरीर टिप्पणियों के शुरू होने से तुरंत ध्यान दें, के रूप में पहले एक रिक्त पंक्ति के खिलाफ) इस मुद्दे को हल करती है।

स्रोत

2012-06-27 14:08:51

Doxygen में शरीर टिप्पणी

उत्तर

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