MavenプラグインとしてGroovydoc

StackOverflow https://stackoverflow.com/questions/5325259

質問

利用可能などこかで利用できるMavenプラグインがありますか？ GroovyDoc, 、できればレポートとして？

私は推測する Gmaven 見る場所になりますが、ドキュメントは古代です（1.0、現在のバージョンは1.3）、Gmavenプラグインはあなたが見ることができるように適合するモジョを持っていません。

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

このプラグインには9つの目標があります。

Groovy：コンパイル
説明：グルーヴィーなソースをコンパイルします。

Groovy：コンソール
説明：Groovy GUIコンソールを起動します。

Groovy：実行
説明：グルーヴィーなスクリプトを実行します。

Groovy：Generatestubs
説明：グルーヴィーなソースからJavaスタブを生成します。

Groovy：GenerateTestStubs
説明：グルーヴィーなテストソースからJavaスタブを生成します。

Groovy：ヘルプ
説明：Gmaven-Pluginのヘルプ情報を表示します。
電話
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
パラメーターの詳細を表示するには。

Groovy：プロバイダー
説明：構成および選択されたグルーヴィーなランタイムプロバイダーに関する情報を表示します。

Groovy：シェル
説明：Groovyシェル（別名Groovysh）を起動します。

Groovy：テストコンパイル
説明：グルーヴィーなテストソースをコンパイルします。

それで、誰かがMaven Groovydocプラグインのポインターを持っていますか？ Googleは意味のあるものを思い付きませんでした。

役に立ちましたか？

解決

gmavenplusプラグインが必要です。 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

他のヒント

Groovydoc Maven互換プラグインはありませんが、Groovyクラスのドキュメントを生成するのは、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>

Groovydoc用のMavenプラグインはないと思いますが、 アリタスク. 。 Gmavenは別のアプローチに従います。 generateStubs Groovyクラス用のJavaスタブを作成し、通常のJavadocプラグインで処理できます。ただし、このアプローチが実際にどれだけうまく機能するかはわかりません。特に、Gmavenの新しいバージョンがGroovyコンパイラのスタブジェネレーターを使用しているため、適切なJavadocを念頭に置いて作成されていないことが作成されていません。

groovydoc mavenプラグインは私のために働きました： https://github.com/rvowles/groovydoc-maven-plugin

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top