2012-10-26 14 views
18

का उपयोग कर मार्कडाउन फ़ाइलों के रूप में प्रलेखन जेनरेट करें मुझे पता है कि टिप्पणियों के अंदर मार्कडाउन का उपयोग करना संभव है और डॉक्सिजन इसे समझ सकता है। लेकिन मुझे यह जानने की जरूरत है कि दस्तावेज को मार्कडाउन प्रारूप में उत्पन्न करना संभव है या नहीं?डॉक्सिजन

मुझे इन दस्तावेज़ों को सी ++ फ़ाइलों से उत्पन्न करने की आवश्यकता है।

+1

मैं कच्चे XML आउटपुट आप शायद अपने स्वयं के markdown रूपांतरण मॉड्यूल लिख सकते हैं का उपयोग कर अनुमान कहते हैं। लेकिन मुझे पूरा यकीन है (भले ही 100% नहीं) प्रत्यक्ष मार्कडाउन आउटपुट संभव नहीं है, फिर भी। –

उत्तर

5

मैं जानता हूँ कि इस सवाल पुराना है लेकिन वहाँ उपलब्ध एक नया उपकरण प्रतीत हो रहा है: https://www.npmjs.com/package/doxygen2md

+0

धन्यवाद। यह उस मुद्दे को हल करने का एक अच्छा तरीका है जो मेरे पास था। – Sudar

5

मुझे कुछ भी पता नहीं है जो इसे सीधे करेगा, लेकिन डॉक्सिजन में XML document using the XML generator आउटपुट करने की क्षमता है।

वहाँ बाहर विभिन्न परियोजनाओं फिर कहा उपभोग कर सकते हैं कि XML डेटा बदलने के लिए, सबसे सरल जो कि मैं Breathe जो कुछ है कि Sphinx उत्पादन प्रलेखन के लिए उपयोग कर सकते हैं करने के लिए एक्सएमएल दस्तावेजों कन्वर्ट करने के लिए प्रयोग किया जाता है के बारे में पता कर रहा हूँ में से एक रहे हैं कहने के लिए एक पूर्व प्रोसेसर के रूप में Doxygen का उपयोग कर।

श्वास के लिए कोड एक शुरुआती बिंदु के रूप में उपयोग करने के लिए पर्याप्त हो सकता है, फिर स्पिन्क्स को आवश्यक पुनर्वित्तित फ़ाइलों की बजाय मार्कडाउन फ़ाइलों को उत्पन्न करने के लिए पर्याप्त हो सकता है। मैंने ब्रीथे के लिए कोड नहीं देखा है, लेकिन मैंने इसे कुछ प्रमुख परियोजनाओं के लिए उपयोग किया है।

+0

श्वास सीधे स्पिंक्स/डॉकुटिल्स पेड़ संरचना में सामग्री डालता है क्योंकि स्फिंक्स फ़ाइलों को पार्स किया जाता है। इंटरमीडिएट रीस्ट्रक्चरर्ड टेक्स्ट फाइलें इस प्रक्रिया में कभी नहीं बनाई गई हैं। –

5

डोक्सिजन http://www.stack.nl/~dimitri/doxygen/customize.html#xmlgenerator के साथ एक्सएमएल जेनरेट करें।

XML से मार्कडाउन में कनवर्ट करने के लिए पैनडोक http://pandoc.org/ का उपयोग करें।

+1

यह एक फर्जी जवाब है, "एक्सएमएल" एक बहुत ही सामान्य प्रारूप है और पैंडोक को डॉक्सिजन के एक्सएमएल आउटपुट के लिए कोई समर्थन नहीं है। –

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