क्यूटी दस्तावेज टिप्पणियों के लिए दस्तावेज़ीकरण? क्यूटी + Doxygen?

Question

क्यूटी दस्तावेज़ीकरण टिप्पणियों के लिए मुझे दस्तावेज़ कहां मिल सकता है? मैं कैसे क्यूटी, प्रलेखन टिप्पणी के लिए एक विशिष्ट शैली का उपयोग करता है तो तरह की चर्चा करते हुए हूँ:

/*! 
    \class MyClassName 
    \brief The MyClassName class is used as an example on Stack Overflow. 

    This class serves a few functions, the most important being: 

    \list 
     \i So people can understand my question. 
     \i So people can have a few laughs at the comedy in my example. 
    \endlist 
*/ 

... आप चित्र मिलता है। तो मुझे सभी स्विच, जैसे \ class, \ list, \ brief, आदि के बारे में जानकारी कहां मिल सकती है। साथ ही, मैं अपनी स्रोत फ़ाइलों में इन टिप्पणियों से दस्तावेज़ फ़ाइलों को उत्पन्न करने के लिए किस टूल का उपयोग करता हूं? क्या डॉक्सिजन इस वाक्यविन्यास का समर्थन करता है?

Answer 1

qdoc का उपयोग न करें। It is deprecated। Doxygen का प्रयोग करें, जो कि qdoc पर आधारित है वैसे भी।

उस ने कहा, प्रलेखन (qdoc प्रारूप में: -D) here है।

Answer 2

आप क्यूटी प्रलेखन टिप्पणी के लिए क्यूटी स्रोत कोड खुद पर एक नज़र ले जा सकते हैं ...

Qt - SRC - 4.6.3

मैं हालांकि प्रलेखन Doxygenका इस्तेमाल किया है प्रलेखन के लिए और यह ठीक काम कर रहा है मेरे लिए, मानकों क्यूटी के नहीं हैं। मेरा सुझाव है कि आप इसे आज़माएं और फैसला करें।

Answer 3

उपयोग Doxygen प्रलेखन

बनाने के लिए यह एक ऑन लाइन प्रलेखन ब्राउज़र (HTML में) और/या दस्तावेज स्रोत फ़ाइलों का एक सेट से एक ऑफ-लाइन संदर्भ मैनुअल (LaTeX) उत्पन्न कर सकते हैं। आरटीएफ (एमएस-वर्ड), पोस्टस्क्रिप्ट, हाइपरलिंक्ड पीडीएफ, संपीड़ित एचटीएमएल, और यूनिक्स मैन पेजों में आउटपुट उत्पन्न करने के लिए भी समर्थन है। प्रलेखन सीधे स्रोतों से निकाला जाता है, जो स्रोत कोड के साथ दस्तावेज़ीकरण को बनाए रखना बहुत आसान बनाता है।

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

http://www.stack.nl/~dimitri/doxygen/

Answer 4

कि क्यूटी विशेष हैं Doxygen के दो हिस्सों रहे हैं। ये केवल डॉक्सिजन के कुछ हिस्सों हैं जिन्हें क्यूटी द्वारा उपयोग किया जाता है। क्यूटी द्वारा उपयोग की जाने वाली सभी डॉक्सिजन टिप्पणियां नियमित डॉक्सिजन सामग्री होती हैं। तो आपको बस डॉक्सिजन पर पढ़ने की जरूरत है।

या शायद आप वास्तव में के रूप में में this blog entry

क्यूटी शैली टिप्पणियाँ निहित इस तरह के पर डी-प्वाइंटर जानकारी के रूप में, क्यूटी internals के प्रलेखन के लिए देख रहे हैं: \ *! पाठ */ टिप्पणी शैली को डॉक्सजिन टिप्पणियों के "क्यूटी स्टाइल" कहा जाता है। "!" संपूर्ण टिप्पणी ब्लॉक को डॉक्सिजन टिप्पणी ब्लॉक के रूप में चिह्नित करता है। यह Doxygen का एक मानक, वैकल्पिक हिस्सा है।

QT_AUTOBRIEF सेटिंग: "QT_AUTOBRIEF" टैग Doxyfile में सही पर सेट किया जाता है, एक क्यूटी शैली टिप्पणी ब्लॉक की पहली पंक्ति स्वचालित रूप से \ संक्षिप्त विवरण के रूप में व्याख्या की है।

doygen जीयूआई मदद से

:

QT_AUTOBRIEF टैग हाँ पर सेट है तो Doxygen के रूप में संक्षिप्त वर्णन एक क्यूटी शैली टिप्पणी के पहले लाइन (पहले डॉट जब तक) की व्याख्या करेगा। यदि नहीं करने के लिए सेट, टिप्पणियां बस नियमित क्यूटी वाली शैली में टिप्पणियां की तरह व्यवहार करेगा (इस प्रकार एक संक्षिप्त विवरण के लिए एक स्पष्ट \ संक्षिप्त आदेश की आवश्यकता होती है।)