2012-07-11 13 views
7

के लिए डॉक्सीजन इंजीनियरिंग कंपनी के लिए मेरी कंपनी एक एपीआई विकसित करती है। यह सी में विकसित की है, लेकिन हम ++ निम्न भाषाओं के लिए यह करने के लिए रैपर बनाने के लिए:एक बहु भाषा एपीआई

  • एक मालिकाना भाषा कि वीबी
  • MATLAB
  • और अजगर जैसा दिखता है।

वर्तमान में दस्तावेज स्क्रिप्ट के एक समूह द्वारा उत्पन्न होता है और इसे 100% रखने के लिए समय लेने वाला लग रहा है। मैं सोच रहा था कि क्या एक बार में सी/सी ++, वीबी और MATLAB के लिए प्रलेखन उत्पन्न करने के लिए डॉक्सिजन/स्फिंक्स या अन्य प्रोग्राम प्राप्त करने का कोई तरीका है। पायथन भाग SWIG द्वारा किया जाता है।

  • NameOfFunction
  • वीबी:: वर्तमान में उत्पादन की तरह कुछ है
  • समारोह NameOfFunction (ByVal एक, जब तक ByRef ख() लांग के रूप में, ByVal ग तक) के रूप में लंबे समय
  • MATLAB:
  • मूल्य = NameOfFunction (ए, बी(), ग)
  • C/C++:
  • मूल्य * NameOfFunction (objtype1 * एक, objecttype2 * ख [], int ग)
  • + विवरण
  • + उदाहरण
+0

पर एक नज़र वहाँ एक config स्क्रिप्ट आप Doxygen के लिए संपादित कर सकते हैं नहीं है? – pyCthon

+0

हाँ, लेकिन मैं जो चाहता हूं उसे पूरा कैसे कर सकता हूं। मैंने इसे देखा था, लेकिन ऐसा कुछ नहीं मिला जो मुझे पसंद था। – Mac

उत्तर

3

Doxygen कई भाषाओं का समर्थन करता है,

कई परियोजनाओं या फ़ोल्डर और भाषाओं पर इस का उपयोग करने के लिए आप केवल आपके config में जाँच करना चाहते हैं हर फ़ोल्डर में Doxygen इशारा करते हैं।

मेरी पसंदीदा प्रोग्रामिंग भाषा एक्स है। क्या मैं अभी भी डॉक्सिजन का उपयोग कर सकता हूं?

नहीं, ऐसा नहीं; डॉक्सिजन को जो भी पढ़ता है उसकी संरचना को समझने की आवश्यकता होती है। यदि आपको इस पर कुछ समय बिताने में कोई फर्क नहीं पड़ता है, तो कई विकल्प हैं:

भाषा X समर्थित है?

तो एक्स के व्याकरण सी या सी ++ के करीब है, तो यह शायद कठिन भी नहीं तो भाषा समर्थित है src/scanner.l थोड़ा tweak है। यह डॉक्सिजन द्वारा समर्थित सभी अन्य भाषाओं के लिए किया जाता है (यानी। जावा, आईडीएल, सी #, PHP)। यदि एक्स के व्याकरण से कुछ अलग है आप को इनपुट फ़िल्टर कि कुछ इसी तरह C/C के लिए पर्याप्त में तब्दील हो एक्स ++ Doxygen को समझने के लिए (इस दृष्टिकोण वीबी के लिए लिया जाता है, ऑब्जेक्ट पास्कल, और जावास्क्रिप्ट, http://www.stack.nl/~dimitri/doxygen/download.html#helpers देखने लिख सकते हैं)। यदि व्याकरण पूरी तरह से अलग है तो एक्स और के लिए एक पार्सर लिख सकता है जो एक बैकएंड लिखता है जो src/scanner.l (और टैग फ़ाइलों को पढ़ने के दौरान src/tagreader.cpp द्वारा भी किया जाता है) के समान वाक्यविन्यास पेड़ उत्पन्न करता है।

हालांकि अपने मालिकाना तरह एक वीबी का उपयोग कर के बाद से, यह इस भाषा लेने सकता है यदि आप बस सिर्फ .vb

की है कि फ़ाइल एक्सटेंशन को बदलने heres कैसे साथ matlab

अजगर इसका इस्तेमाल करने के और C++ पहले से ही समर्थन कर रहे

है एफ AQ पेज

2

Doxygen साइट पर आप अनुकूल करने के लिए सक्षम हो सकता है कि, विभिन्न भाषाओं के लिए 3 पार्टी सहायकों के लिंक के साथ एक पृष्ठ है:

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

वीबी और MatLab फ़िल्टर का उल्लेख किया गया है।

2

मैं सोच रहा था कि क्या डॉक्सिजन/स्फिंक्स या अन्य प्रोग्राम को सी/सी ++, वीबी और मैटलैब के लिए दस्तावेज उत्पन्न करने का कोई तरीका है।

ज़ीउस संपादक के पास doxygen feature है जो आपको ज़ीउस वर्कस्पेस में सभी वस्तुओं के लिए डॉक्सिजन दस्तावेज़ बनाने की अनुमति देता है।

+0

धन्यवाद, लेकिन मुझे अन्य डेवलपर्स को अन्य आईडीई का उपयोग शुरू करना मुश्किल लगता है। – Mac

+0

मुझे यह विश्वास करना बहुत मुश्किल लगता है कि केवल एक विशेष संपादक का उपयोग करके जादुई रूप से डॉक्सिजन समर्थन मनमानी फाइलें कर देगा। –

+0

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

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