2011-03-16 48 views
8

是否有一個maven插件可用的地方,利用GroovyDoc,最好作爲報告?GroovyDoc作爲Maven插件

我猜GMaven會看的地方,但文檔是古(1.0,而目前的版本是1.3)和GMaven插件沒有適合你可以看到任何魔力:

mvn help:describe -DgroupId=org.codehaus.gmaven -DartifactId=gmaven-plugin 

這個插件有9個進球:

常規:編譯
說明:編譯 Groovy的來源。

常規:控制檯
描述:推出 Groovy的GUI控制檯。

常規:執行
說明:執行 Groovy腳本。

常規:generateStubs
說明: 生成在Groovy 來源Java存根。

常規:generateTestStubs
說明:生成 Groovy的測試源Java存根。

常規:有助於
描述:gmaven-插件顯示 幫助信息。
致電
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
顯示參數詳細信息。

常規:提供商
說明:關於哪些 被配置和選擇Groovy的 運行時提供商 顯示信息。

常規程序:外殼
描述:推出 Groovy的殼牌(又名groovysh)。

常規:testCompile
描述: 編譯Groovy的測試源。

那麼有沒有人有任何指向maven groovydoc插件的指針?谷歌沒有拿出任何有意義的東西。

+2

GMaven的作者嘗試重寫插件(https://github.com/keeganwitt/GMavenPlus)。其中一個目標是提供對GroovyDoc的支持,但在撰寫本文時尚未發佈。 – sworisbreathing 2012-11-19 02:19:12

+0

@sworisbreathing很高興知道,謝謝 – 2012-11-19 07:23:08

+0

@ sean-patrick-floyd我打算在本月發佈測試版。我正在努力設置Maven存儲庫。 – Keegan 2013-06-08 03:48:44

回答

2

http://groovy.github.io/GMavenPlus/groovydoc-mojo.html

<project> 
    <build> 
    <plugins> 
     <plugin> 
     <groupId>org.codehaus.gmavenplus</groupId> 
     <artifactId>gmavenplus-plugin</artifactId> 
     <version>1.5</version> 
     </plugin> 
    </plugins> 
    </build> 
    <dependencies> 
    <dependency> 
     <groupId>org.codehaus.groovy</groupId> 
     <artifactId>groovy-all</artifactId> 
     <!-- any version of Groovy \>= 1.5.0 (except 1.6 RC 1) should work here --> 
     <version>2.4.7</version> 
    </dependency> 
    </dependencies> 
</project> 

並運行:mvn gplus:generateStubs gplus:groovydoc

+1

對我來說太晚了,但希望它能幫助別人。謝謝! – 2017-01-19 12:57:03

3

我不認爲Groovydoc有Maven插件,但您可以使用Ant task。 GMaven遵循不同的方法:generateStubs爲Groovy類創建Java存根,然後可以由常規Javadoc插件處理。然而,我不知道這種方法在實踐中效果如何,特別是因爲新版本的GMaven使用Groovy編譯器的存根生成器,而這種生成器並不是以創建適當的Javadoc爲目標而創建的。

8

雖然沒有任何Groovydoc maven兼容插件,但使用Maven生成groovy類的文檔非常容易。這是我們在我們的項目做的方式:GroovyDoc的Maven插件爲我工作

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-antrun-plugin</artifactId> 
    <version>1.7</version> 
    <executions> 
    <execution> 
     <id>groovydoc</id> 
     <phase>site</phase> 
     <goals> 
     <goal>run</goal> 
     </goals> 
     <configuration> 
     <target> 
      <taskdef name="groovydoc" 
      classname="org.codehaus.groovy.ant.Groovydoc" 
      classpathref="maven.compile.classpath" 
      /> 
      <groovydoc destdir="${project.reporting.outputDirectory}/groovydoc" 
      sourcepath="${basedir}/src/main/groovy" use="true" 
      windowtitle="${project.name}" 
      doctitle="${project.name}" 
      > 
      <link packages="java.,org.xml.,javax.,org.xml." 
       href="http://download.oracle.com/javase/6/docs/api" /> 
      <link packages="org.apache.tools.ant." 
       href="http://evgeny-goldin.org/javadoc/ant/api" /> 
      <link packages="org.junit.,junit.framework." 
       href="http://kentbeck.github.com/junit/javadoc/latest" /> 
      <link packages="groovy.,org.codehaus.groovy." 
       href="http://groovy.codehaus.org/api/" /> 
      <link packages="org.codehaus.gmaven." 
       href="http://evgeny-goldin.org/javadoc/gmaven" /> 
      </groovydoc> 
     </target> 
     </configuration> 
    </execution> 
    </executions> 
</plugin> 
+0

我會接受這一點,因爲它似乎工作,即使我不再需要它。 – 2011-12-07 14:12:52

+0

爲什麼你不再需要它?你找到了替代解決方案嗎? – mindthief 2012-11-05 14:54:18