क्या विशेष फाइलों पर "दस्तावेज नहीं" चेतावनियां देने से डॉक्सिजन को दबाने का कोई तरीका है? मेरे प्रोजेक्ट में कई स्वचालित रूप से जेनरेट किए गए कोड हेडर हैं जो इसे सैकड़ों या हजारों त्रुटियों को फेंकने का कारण बनते हैं जिससे इसे मुश्किल करना मुश्किल हो जाता है।डॉक्सिजन चेतावनियों को दबाने
आप उत्पन्न फ़ाइलों में दमन टैग का उपयोग कर सकते हैं:
//! @cond Doxygen_Suppress
code
//! @endcond
आप "Doxygen_Suppress" वहाँ में की जरूरत नहीं है, लेकिन मैं इसे स्पष्टता के लिए पसंद करते हैं।
संपादित में और अधिक विकल्प हैं: ठीक है, मैं अपने कारण परिश्रम करना चाहिए था, मैं एक जवाब है कि अपनी स्थिति के लिए अधिक उपयुक्त है। मेरा मानना है कि आपको फ़ाइलों को पूरी तरह से बाहर करने की आवश्यकता है। अपने Doxygen फ़ाइल से जोड़ें: तो
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = abc.cpp \
abc.h
विडंबना मैं इस समस्या थी और इसे हल किया है, यह सब के बारे में भूल ... ब्रेन फिर से पूरा किया जाना चाहिए।
मैंने इस जानकारी को doxygen Configuration page से खींच लिया है, लेकिन यदि आप मेरे जैसे आलसी हैं, तो बस gui टूल (doxywizard) का उपयोग करें और अपनी इच्छित चीजों का चयन करें और इसे अपने लिए डॉक्सफाइल सहेजें।
वहाँ उस के लिए एक config विकल्प, के रूप में documentation
WARN_IF_UNDOCUMENTEDमें कहा गया है
WARN_IF_UNDOCUMENTEDYESके लिए सेट है, तो Doxygen अप्रलेखित सदस्यों के लिए चेतावनी उत्पन्न होगा तो है। यदिEXTRACT_ALLYESपर सेट है तो यह ध्वज स्वचालित रूप से अक्षम हो जाएगा।
क्या मैं इसे किसी भी प्रकार का दायरा दे सकता हूं ताकि यह मेरी फाइलों के लिए चेतावनी दे और दूसरों को अनदेखा कर सके? –
हमम .. ऐसा नहीं लगता है कि आप कर सकते हैं। फ़ाइलों को पूरी तरह से बाहर करना संभव है, लेकिन चुनिंदा चेतावनी चेतावनी नहीं है ... :( – Mchl
हालांकि यह लिंक प्रश्न का उत्तर दे सकता है, लेकिन यहां उत्तर के आवश्यक हिस्सों को शामिल करना बेहतर है और संदर्भ के लिए लिंक प्रदान करना बेहतर है। केवल लिंक के जवाब लिंक किए गए पृष्ठ में परिवर्तन होने पर अमान्य हो सकता है। –
मेरे स्वचालित रूप से जेनरेट किए गए हेडर में मैं केवल ऑटो-पीढ़ी के दिनचर्या में डॉक्सिजन दस्तावेज़ जोड़ता हूं।
इसका मतलब है कि कुछ भी अनियंत्रित नहीं छोड़ा गया है।
किसी ग्रहण उपयोग कर रहा है, तो मैं निश्चित रूप से अपनी फ़ाइल को खोलने के लिए सुझाव देते हैं (* .doxyfile) एक पाठ संपादक (नोट ग्रहण है कि "Doxyfile संपादक" डिफ़ॉल्ट रूप से साथ इसे खोलने के) के साथ।
तो:
टैग जोड़ने से
//! @cond Doxygen_Suppress
code
//! @endcond
अगर आप कई वर्गों उबाऊ और कठिन होना चाहिए।
अन्य कॉन्फ़िगरेशन विकल्पों के लिए दस्तावेज़ीकरण here उपलब्ध है।
जेनरेट की गई फाइलों को उड़ा दिया जाता है और हर बार जब मैं प्रोजेक्ट सेटिंग्स में कोई बदलाव करता हूं तो पुन: बनाया जाता है। टूल मुझे जेनरेट की गई फाइलों में टिप्पणियां डालने की इजाजत देता है, लेकिन वे सभी ब्लॉक में हैं, हालांकि खुले '\ cond की प्रतीत होती है काम करने के लिए। सबसे बुरे अपराधी हालांकि (एक आईओ मैप हेडर जो प्रोसेसर के प्रत्येक एकल रजिस्टर और बिट फ़ील्ड को सूचीबद्ध करता है *) मैं इसे नहीं कर सकता। –
खुले टैग प्रतीत होता है कि मेरे कुछ कोड के दस्तावेज़ों में दूसरी नज़र में हस्तक्षेप हो रहा है; उल्लेखनीय रूप से '# परिभाषित करता है, लेकिन शीर्षलेखों में अधिकतर दस्तावेज। –