2009-01-21 65 views
11

我正在将我的第一个taglib作为插件的一部分编写,我想将其记录下来。添加javadoc(有没有文件groovydoc的地方,还是它真的是同一件事?)似乎不适用于非方法。如何在Groovy/Grails中记录taglibs(或通常关闭)

具体来说,如何记录在DEF mytag:

​​

由于很多事情Grails中使用封闭指定,如果它真的无法记录它们,那么它看起来像我们有一个问题。是否有其他解决方案涉及单独的文档文件,我应该使用?

回答

3

我刚刚阅读了关于新的Groovy 1.6 RC,它将我引向Jira,它有几个关于groovydoc的开放式错误,其中包括一个专门用于记录fields and properties的漏洞,该漏洞仍处于开放状态。最新的评论提到了trunk的部分实现,所以我必须检查一下。

这样就清除了当前状态。与此同时,我强迫自己将我的taglib发布到野外,并将其记录下来,这是我使用普通的HTML页面(wiki生成的)完成的。有一件事需要说明,因为如果一个taglib的详细信息被发现埋在大量自动生成的沉船中,我实际上会被推迟。

0

你的问题让我好奇,我做了一些四处张望。似乎没有一种好的方法来做到这一点。

我在想,目前这样做的最优方法是仅在类级别的javadoc头文件中记录可用标签及其参数。至少它们会出现在你的最终API规范中供人们看。

我注意到有关于groovydoc的一些讨论,但我似乎无法找到任何完全官方的说明,特别是在使用Grails方面。我能够使用下面的代码让我的一个grails 1.0.3应用程序获得groovydoc的工作,但是当我添加它们时,它并没有在我的taglib关闭中选择任何文档注释。

<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的得到它,如果你惹它足够长的时间与标签库的工作,或者它可以与Grails的1.1测试版的工作,如果你一定要尝试的时间。