GroovyDoc 作为 Maven 插件

2024-01-04

是否有一个 Maven 插件可以利用GroovyDoc http://groovy.codehaus.org/gapi/index.html?org/codehaus/groovy/groovydoc/GroovyDoc.html,最好作为报告?

I guess GMaven http://docs.codehaus.org/display/GMAVEN/Home应该是一个值得一看的地方,但文档很古老(1.0,而当前版本是 1.3),并且 GMaven 插件没有任何适合您的魔力,如您所见:

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

这个插件有 9 个目标:

常规:编译
描述:编译 绝妙的来源。

常规:控制台
描述: 发射 Groovy GUI 控制台。

常规:执行
描述:执行 Groovy 脚本。

groovy:生成存根
描述: 从 Groovy 生成 Java 存根 来源。

groovy:生成测试存根
描述:生成 Java 存根 Groovy 测试源。

绝妙:帮助
描述:显示 有关 gmaven-plugin 的帮助信息。
称呼
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
显示参数详细信息。

常规:提供商
描述: 显示有关 Groovy 的信息 运行时提供者 已配置并选择。

常规:外壳
描述: 发射 Groovy Shell(又名 groovysh)。

groovy:测试编译
描述: 编译 Groovy 测试源。

那么有人有任何指向 Maven groovydoc 插件的指示吗?谷歌没有想出任何有意义的东西。


尽管没有任何 Groovydoc maven 兼容插件,但使用 Maven 为您的 groovy 类生成文档非常容易。这就是我们在项目中所做的方式:

<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>
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

GroovyDoc 作为 Maven 插件 的相关文章

随机推荐