Groovydoc как плагин Maven

Question

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

Наверное Gmaven было бы место, чтобы посмотреть, но документы древние (1.0, тогда как текущая версия составляет 1,3), а плагин Gmaven не имеет никакого моджо, который подходит, как вы можете видеть:

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

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

Groovy: Compile
Описание: Скомпилируйте Groovy Sources.

Groovy: Консоль
Описание: запускает консоль Groovy GUI.

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

Groovy: Generatestubs
Описание: генерируйте Java -заглушки из Groovy Sources.

Groovy: generateteststubs
Описание: генерируйте Java -заглушки из Groovy Sources.

Groovy: Помогите
Описание: отображать информацию справки на Gmaven-Plugin.
Вызов
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
Чтобы отобразить детали параметра.

Groovy: поставщики
Описание: Отображает информацию о поставщиках Groovy Runtime, которые настроены и выбраны.

Groovy: Shell
Описание: запускает Groovy Shell (AKA. Groovysh).

Groovy: TestCompile
Описание: Скомпилируйте Groovy Sources.

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

Answer 1

Вы хотите плагин Gmavenplus: http://groovy.github.io/gmavenplus/grovydoc-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 2

Хотя нет никакого совместимого с 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 3

Я не думаю, что есть плагин Maven для Groovydoc, но вы можете использовать Муравей задача. Анкет Gmaven следует за другим подходом: generateStubs Создает Java Actubs для класса Groovy, которые затем могут обрабатывать обычный плагин Javadoc. Тем не менее, я не знаю, насколько хорошо работает этот подход на практике, в частности потому, что новые версии Gmaven используют Groovy Compiler Generator, который не был создан с целью создания правильного Javadoc.

Answer 4

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