 ------
 Configuring Generation of Documentation Reports
 ------
 Vincent Siveton
 ------
 2008-01-01
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements.  See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership.  The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License.  You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied.  See the License for the
~~ specific language governing permissions and limitations
~~ under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

Configuring Generation of Documentation Reports

 To configure the generation of the documentation reports, add the following to the project's POM:

+-----+
<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-report-plugin</artifactId>
        <version>${project.version}</version>
        <reportSets>
          <reportSet>
            <reports>
              <report>report</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      </plugin>
    </plugins>
    ...
  </reporting>
  ...
</project>
+-----+

* Generate Plugin Report without duplicate execution of phase process-classes

 The standard report goal <<<report>>> invokes separate lifecyle of <<<process-classes>>>.
 In a CI environment you now might execute something like <<<mvn clean deploy site-deploy>>>.
 During <<<site>>> build the standard reports will trigger <<<process-classes>>> again.
 Depending on your build this may take some time because
 stuff like <<<enforcer>>> or generating stubs from a WSDL will be invoked again, which may lead
 to longer build times.

 As of version 3.14.0 a new report goal is defined, <<<report-no-fork>>> which will not trigger
 the above phase a second time.

 Configure this in your <<<reporting>>> section as follows:

+-----+
<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-report-plugin</artifactId>
        <version>${project.version}</version>
        <reportSets>
          <reportSet>
            <reports>
              <report>report-no-fork</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>
+-----+

 The documentation is generated by default in <<<$\{project.build.directory\}/site>>>.
