2013-09-07 9 views
5

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

दस्तावेज शीर्षलेख फ़ाइल का केवल एक अंश, संरचनाएं, वास्तव में किसी भी डॉक्सिजन आउटपुट में दिखाई देती हैं। मैं कॉन्फ़िगरेशन सेटिंग्स या दस्तावेज़ीकरण में कुछ भी नहीं देख सकता जो स्पष्टीकरण में सहायता करेगा कि डॉक्सिजन हेडर फ़ाइल से दस्तावेज़ जेनरेट किए गए आउटपुट में दस्तावेज़ कोड क्यों नहीं रखता है।

क्या कोई जानता है कि यह क्यों होगा? http://www.doxygen.org/manual/faq.html

संक्षेप में आप की संभावना @file के साथ एक टिप्पणी ब्लॉक अपने हेडर फाइल दस्तावेज़ के लिए याद कर रहे हैं:

उत्तर

3

2 और पूछे जाने वाले प्रश्न के 3 आइटम देखें।

+0

@file टिप्पणी फ़ाइल में है और faq में किसी भी समाधान में कोई फर्क नहीं पड़ता है। वे नामस्थानों के बारे में बात करते हुए कक्षा के आधार पर लिखे गए हैं, लेकिन चूंकि मैं सीधी सी हैडर हूं, इसलिए यह समझा सकता है कि क्यों फक समाधान मेरी मदद नहीं कर रहे हैं। – jwhitmore

+2

@ फ़ाइल को काम करना चाहिए था, इसलिए कृपया एक स्वयं निहित उदाहरण पोस्ट करें (या तो यहां या डॉक्सिजन के बग ट्रैकर में) ताकि मैं स्वयं समस्या को पुन: उत्पन्न कर सकूं। – doxygen

+0

ओह! @file दस्तावेज़ फ़ाइल दस्तावेज में बहुत अधिक दस्तावेज करता है लेकिन वास्तव में जो मैं खो रहा हूं वह एपीआई फ़ंक्शन है। दुर्भाग्यवश हेडर में एपीआई फ़ंक्शंस को सी पॉइंटर्स के रूप में घोषित किया जाता है। मैं उन्हें "\ fn" के साथ दस्तावेज कर रहा हूं लेकिन ये बिल्कुल दिखाई नहीं देते हैं। – jwhitmore

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