Maven Javadoc - Невозможно сгенерировать Javadoc - PullRequest
Новая
       9

Maven Javadoc - Невозможно сгенерировать Javadoc

3 голосов
/ 13 октября 2011

У меня есть следующая зависимость и встроенный в мой файл pom Я могу вручную создать Javadoc с помощью команды Maven. Я также могу успешно выполнить сборку. В выводе вообще не упоминается Javadoc. Я также попытался пропустить пути к выходным каталогам. POM файл Раздел зависимости: 

<dependency>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.8</version>
</dependency>

, а затем раздел сборки: 

<build>
    <finalName>D</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.8</version>
            <configuration> 
                <outputDirectory>${project.build.directory}/javadoc</outputDirectory>
                <reportOutputDirectory>${project.reporting.outputDirectory}/javadoc</reportOutputDirectory>
                <version>2.8</version>
            </configuration>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>aggregate</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

1 Ответ

12 голосов
/ 13 октября 2011

Плагин Maven Javadoc не запускается по умолчанию и его необходимо привязать к одной из фаз жизненного цикла Maven по умолчанию.

Вот как я бы написал конфигурацию плагина: 

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.8</version>
        <configuration> 
            <outputDirectory>${project.build.directory}/javadoc</outputDirectory>
            <reportOutputDirectory>${project.reporting.outputDirectory}/javadoc</reportOutputDirectory>
        </configuration>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <phase>site</phase>
                <goals>
                    <goal>aggregate</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

Обратите внимание, как я добавил дополнительный phase элемент к выполнению.Это свяжет его с целью «сайта», чтобы при запуске mvn site генерировались javadocs.Отметьте Введение в жизненный цикл сборки , если вам нужен один из этапов сборки Java по умолчанию.

Также обратите внимание, что я исключил параметр version;по умолчанию он должен использовать версию вашего POM в любом случае.

...