GroovyDoc как плагин Maven

Question

Есть ли где-нибудь доступный плагин maven, который использует GroovyDoc, предпочтительно в качестве отчета?

Я думаю, GMaven было бы местом для поиска, нодокументы древние (1.0, тогда как текущая версия 1.3), и у плагина GMaven нет ни одного mojo, который подходит, как вы можете видеть:

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

Этот плагин имеет 9 целей:

groovy: compile
Описание: компилирует Groovy исходники.

groovy: console
Описание: Запускает консоль Groovy GUI.

groovy: выполнить
Описание: выполняет сценарий Groovy.

groovy: generateStubs
Описание: генерировать заглушки Java из источников Groovy.

groovy: generateTestStubs
Описание: создание Java-заглушек из тестовых источников Groovy.

groovy: help
Описание: отображение справкиинформация о gmaven-plugin.
Вызовите
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
, чтобы отобразить детали параметров.

groovy: провайдеры
Описание: отображает информацию о настроенных и выбранных провайдерах Groovy.

groovy: shell
Описание: Запускает Groovy Shell (он же.groovysh).

groovy: testCompile
Описание: Компилирует источники тестов Groovy.

Так есть ли у кого-нибудь указатели на плагин maven groovydoc?Google не придумал ничего значимого.

Answer 1

Несмотря на то, что нет 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>

Answer 2

Не думаю, что есть плагин Maven для Groovydoc, но вы можете использовать задачу Ant . GMaven использует другой подход: generateStubs создает Java-заглушки для классов Groovy, которые затем могут быть обработаны обычным плагином Javadoc. Однако я не знаю, насколько хорошо этот подход работает на практике, в частности потому, что в более новых версиях GMaven используется генератор заглушек компилятора Groovy, который не был создан с целью создания надлежащего Javadoc.

Answer 3

Требуется плагин 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

Answer 4

Плагин Groovydoc Maven работал для меня: https://github.com/rvowles/groovydoc-maven-plugin