Looking for doxygen Answers? Try Ask4KnowledgeBase
Looking for doxygen Keywords? Try Ask4Keywords

doxygenकयामत से शुरुआत हो रही है


टिप्पणियों

इस अनुभाग में यह दर्शाया गया है कि क्या doxygen है, और क्यों एक डेवलपर इसका उपयोग करना चाहता है।

इसमें डॉक्सिज़न के भीतर किसी भी बड़े विषय का उल्लेख करना चाहिए, और संबंधित विषयों से लिंक करना चाहिए। चूंकि doxygen के लिए दस्तावेज़ीकरण नया है, इसलिए आपको उन संबंधित विषयों के प्रारंभिक संस्करण बनाने की आवश्यकता हो सकती है।

अपने कोड टिप्पणी

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

/**
 * … text …
 */
int dummy_var;
 

अगला विकल्प क्यू शैली का उपयोग करना है और सी-स्टाइल टिप्पणी ब्लॉक के उद्घाटन अनुक्रम के बाद विस्मयादिबोधक चिह्न (!) जोड़ना है:

/*!
 * … text …
 */
void foo(void);
 

एक तीसरा विकल्प कम से कम दो C ++ टिप्पणी लाइनों के एक ब्लॉक का उपयोग करना है, जहां प्रत्येक पंक्ति एक अतिरिक्त स्लैश या एक उत्तेजना कनेक्शन के साथ शुरू होती है:

/// 
/// ... text ... 
///
 

या

//! 
//! ... text ... 
//!
 

कुछ लोग अपने टिप्पणी ब्लॉकों को प्रलेखन में अधिक दृश्यमान बनाना पसंद करते हैं। इस प्रयोजन के लिए आप निम्नलिखित का उपयोग कर सकते हैं:

 /********************************************//** 
  * ... text 
  ***********************************************/
 

सामान्य टिप्पणी ब्लॉक को समाप्त करने और एक विशेष टिप्पणी ब्लॉक शुरू करने के लिए 2 स्लैश पर ध्यान दें।

/////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////
 

उत्पन्न प्रलेखन की संरचना और fomat करने के लिए, Doxygen विशेष आदेशों की एक बड़ी संख्या (> 170) प्रदान करता है। प्रलेखन में सभी कमांड एक बैकस्लैश () या एक एट-साइन (@) के साथ शुरू होते हैं।

उदाहरण के लिए

/**
 * \brief    A brief description in one short sentence.
 */
 

के बराबर है

/**
 * @brief    A brief description in one short sentence.
 */
 

संक्षिप्त विवरण के लिए भी कई संभावनाएँ हैं:

एक उपरोक्त टिप्पणी ब्लॉक में से एक के साथ \brief आदेश का उपयोग कर सकता है। यह कमांड एक पैराग्राफ के अंत में समाप्त होता है, इसलिए विस्तृत विवरण एक खाली लाइन के बाद आता है।

/** \brief Brief description. 
 * Brief description continued. 
 * 
 * Detailed description starts here. 
 */ 
 

यदि JAVADOC_AUTOBRIEF कॉन्फ़िगरेशन फ़ाइल में YES सेट है, तो JavaDoc शैली टिप्पणी ब्लॉकों का उपयोग करके स्वचालित रूप से एक संक्षिप्त विवरण शुरू हो जाएगा, जो एक स्थान या नई लाइन के बाद पहले डॉट पर समाप्त होता है।

/// Brief description which ends at this dot. Details follow 
/// here. 
 

और अंत में यहाँ doxygen के साथ एक फ़ंक्शन के पूर्ण प्रलेखन के लिए एक उदाहरण है:

/**
 * \brief   The function bar. 
 *
 * \details This function does something which is doing nothing. So this text
 *          is totally senseless and you really do not need to read this,
 *          because this text is basically saying nothing.
 *
 * \note    This text shall only show you, how such a \"note\" section
 *          is looking. There is nothing which really needs your notice,
 *          so you do not really need to read this section.
 *
 * \param[in]     a    Description of parameter a.
 * \param[out]    b    Description of the parameter b.
 * \param[in,out] c    Description of the parameter c.
 *
 * \return        The error return code of the function.
 *
 * \retval        ERR_SUCCESS    The function is successfully executed
 * \retval        ERR_FAILURE    An error occurred
 */

errcode_t bar(int a, int b, int c)
{    
    /** More detailed description inside the code */
}
 

स्रोत और Doxygen होमपेज पर अधिक जानकारी

स्थापना या सेटअप

Doxygen स्थापित या स्थापित होने के बारे में विस्तृत निर्देश।