2011-06-13 7 views
10

बिल्डिंग करते समय डॉक्सिजन Compound ? is not documented. चेतावनी दिखाता है। एक विशिष्ट परियोजना के लिए मैं यौगिकों को दस्तावेज नहीं करना चाहता हूं। अव्यवस्था को हटाने के लिए मैं उसे छोड़कर अन्य सभी चेतावनियों को देखना चाहता हूं। क्या डॉक्सिजन आउटपुट को साफ करने का कोई तरीका है?क्या यह चुनना संभव है कि कौन सी डॉक्सीजन चेतावनी दिखाना है?

उत्तर

5

मुझे नहीं लगता कि यह संभव है, डॉक्सिजन आउटपुट फ़िल्टर करने के लिए अपने स्वयं के पोस्ट प्रोसेसर को लिखकर। आपके मामले में, यह बहुत कठिन नहीं होना चाहिए, एक सरल grep पर्याप्त होना चाहिए:

doxygen <config_file> | grep -v "warning: Compound .* is not documented" 

मैं सच में यकीन है कि क्यों Doxygen इस सुविधा प्रदान नहीं करता है नहीं कर रहा हूँ: शायद यह बहुत ज्यादा विकल्प की आवश्यकता होगी, या और अधिक जटिल विकल्प। एक और संभावना यह है कि उन्होंने माना कि चूंकि आप किसी दस्तावेज़ को दस्तावेज नहीं होने पर चेतावनी देना चाहते हैं, इसलिए स्रोत कोड में स्पष्ट रूप से निर्दिष्ट किए जाने के अलावा कोई अपवाद नहीं होना चाहिए (उदाहरण के लिए \cond और \endcond का उपयोग करके), तर्क के साथ कि इस प्रकार की चूक केवल मामले-दर-मामले के आधार पर निर्णय लिया जाना चाहिए। या शायद किसी ने कभी भी यह सुविधा शामिल करने के लिए नहीं कहा: feature request भरने के लिए स्वतंत्र महसूस करें।

2

मुझे लगता है कि आप जो खोज रहे हैं वह if, ifnot और endif आदेश है। बस एक उपयुक्त लेबल तय करें, फिर सही टैग का उपयोग करें। पूर्व .: अगर यह इस लेबल के जानता है और अगर ऐसा नहीं होता है, वह किसी भी टिप्पणी को \endif आदेश के लिए एक ही टिप्पणी ब्लॉक में ध्यान नहीं देंगे

/* 
* \if DISPLAY_COMPOUND 
* Compound doc. 
* ... 
* \endif 
*/ 

Doxygen का मूल्यांकन करेंगे

तो फिर तुम करने की जरूरत है ENABLED_SECTIONS में अपने डॉक्सफाइल में लेबल को परिभाषित करें (या नहीं)।

#comment the next line if you don't want to document Compound 
ENABLED_SECTIONS = DISPLAY_COMPOUND 

\cond और \endcond आदेशों पर एक नज़र भी जो समान है, लेकिन काफी एक ही (वे सक्षम या अक्षम एक फ़ाइल के पूरे वर्गों, न सिर्फ एक भी टिप्पणी ब्लॉक) नहीं हैं।

+0

मेरे Doxyfile कहते हैं 'ENABLED_SECTIONS =' (खाली)। आपका जवाब मेरी समस्या को कवर नहीं करता है। मैं यौगिक डॉक्टर पीढ़ी को सक्षम या अक्षम नहीं करना चाहता हूं। मैं केवल यौगिकों के लिए चेतावनियों को अक्षम करना चाहता हूं। –

0

आप डॉक्सिजन कॉन्फ़िगरेशन में चेतावनियां बंद कर सकते हैं। यहाँ देखें: doxygen documenation

मेरा पसंदीदा है: WARN_IF_UNDOCUMENTED = नहीं

+0

आप यह विकल्प कहां रखा है? मैं नहीं कर सकता .. –

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