Groovydoc как плагин Maven

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

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

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

этот плагин имеет 9 голы:

groovy: compile
Описание: Компиляция Отличный источники.

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

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

groovy: generateStubs
Описание:: Создание Java-заглушек из Groovy источники.

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

groovy:помогите
Описание: Дисплей справочная информация по gmaven-плагину.
Звоните
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
для отображения сведений о параметрах.

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

groovy: shell
Описание: Запуски Groovy-оболочка (также известный как. groovysh).

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

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

8
gmaven-plugin groovy groovydoc maven maven-2

4 ответов

вы хотите плагин 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

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>
8

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

3

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

0