ग्रोवी/ग्रेल्स

Question

में टैगलिब्स (या सामान्य रूप से बंद) को कैसे दस्तावेज़ित करें मैं प्लगइन के हिस्से के रूप में अपना पहला टैगलिब लिख रहा हूं और मैं इसे दस्तावेज़ करना चाहता हूं। जावाडोक जोड़ना (क्या कोई ऐसी जगह है जो दस्तावेज groovydoc है या यह वास्तव में एक ही बात है?) गैर तरीकों के लिए काम नहीं लग रहा है।

विशेष रूप से, में डीईएफ़ mytag दस्तावेज़ के लिए कैसे:

/** 
* This doc shows up 
*/ 
class MyTagLib { 
    static namespace = "myns" 

    /** 
    * This doc does not show up, but I'd like to document attrs. 
    */ 
    def mytag = {attrs -> 
    out << "something" 
    } 
} 

के रूप में Grails में चीजों के बहुत सारे निर्दिष्ट बंद का उपयोग कर रहे हैं, अगर यह वास्तव में उन्हें दस्तावेज़ के लिए संभव नहीं है, तो यह है कि हम एक समस्या है लग रहा है। क्या कोई अन्य समाधान है जिसमें अलग-अलग दस्तावेज फाइलें शामिल हैं जिनका उपयोग करना चाहिए?

Answer 1

मैंने अभी नए ग्रोवी 1.6 आरसी के बारे में पढ़ा है, जो मुझे जिरा की ओर ले जाता है, जिसमें ग्रोविडॉक से संबंधित कुछ खुली बग हैं, जिनमें से एक विशेष रूप से fields and properties दस्तावेज करने के बारे में है, जो अभी भी खुला है। नवीनतम टिप्पणी ट्रंक में आंशिक कार्यान्वयन की बात करती है, इसलिए मुझे इसे देखना होगा।

तो यह वर्तमान स्थिति को साफ़ करता है। इस बीच, मैंने खुद को अपनी टैगलिब को जंगली में छोड़ने के लिए मजबूर कर दिया और साथ ही इसे दस्तावेज करने के लिए भी मजबूर किया, जिसे मैंने नियमित HTML पृष्ठ (विकी-जेनरेट) का उपयोग करके किया था। इसके लिए कुछ कहा जाना है, क्योंकि वास्तव में एक टैगलिब पर ब्योरे के साथ एकमात्र दस्तावेज़ों को ऑटो-जेनरेटेड ड्रेक में दफनाया गया था, इसलिए मुझे वास्तव में बंद कर दिया जाएगा।

Answer 2

आपके प्रश्न ने मुझे उत्सुक बना दिया और मैंने कुछ देखा। ऐसा प्रतीत नहीं होता कि ऐसा करने का एक अच्छा तरीका है।

मैं इस समय ऐसा करने का सबसे इष्टतम तरीका सोच रहा हूं कि केवल उपलब्ध टैग और उनके तर्कों को क्लास-स्तरीय जावाडोक हेडर में दस्तावेज करना होगा। कम से कम इस तरह वे लोगों को देखने के लिए आपके अंतिम एपीआई स्पेक में दिखाई देंगे।

मुझे पता है कि ग्रोविडॉक के बारे में कुछ चर्चा है, लेकिन मुझे इसके बारे में पूरी तरह से कुछ भी नहीं मिल रहा है, खासकर Grails के उपयोग के संदर्भ में। मैं निम्नलिखित कोड के साथ अपने grails 1.0.3 ऐप्स में से एक पर groovydoc काम करने में सक्षम था, लेकिन जब मैंने उन्हें जोड़ा था तो यह मेरे टैगलिब बंद होने पर किसी भी दस्तावेज़ टिप्पणियों को नहीं उठाया।

<property environment="env"/> 
<target name="groovydoc"> 
    <taskdef name="groovydoc" classname="org.codehaus.groovy.ant.Groovydoc"> 
    <classpath> 
     <path path="${env.GRAILS_HOME}/lib/groovy-all-1.5.6.jar"/> 
    </classpath> 
    </taskdef> 
    <mkdir dir="docs/gapi"/> 
    <groovydoc destdir="docs/gapi" sourcepath="grails-app" use="true" windowtitle="groovydoc" private="true"/> 
</target> 

आप groovydoc की मालिश करने अगर आप काफी लंबे समय से इसके साथ गड़बड़ यह taglibs के साथ काम करने के लिए सक्षम हो सकता है, या यह Grails 1.1 बीटा के साथ काम कर सकते हैं अगर आप समय यह कोशिश करने के लिए मिल गया है।