View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.javadoc;
20  
21  import javax.inject.Inject;
22  
23  import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
24  import org.apache.maven.doxia.tools.SiteTool;
25  import org.apache.maven.plugins.annotations.Execute;
26  import org.apache.maven.plugins.annotations.LifecyclePhase;
27  import org.apache.maven.plugins.annotations.Mojo;
28  import org.apache.maven.plugins.annotations.ResolutionScope;
29  import org.apache.maven.plugins.javadoc.resolver.ResourceResolver;
30  import org.apache.maven.project.ProjectBuilder;
31  import org.apache.maven.toolchain.ToolchainManager;
32  import org.codehaus.plexus.archiver.manager.ArchiverManager;
33  import org.eclipse.aether.RepositorySystem;
34  
35  /**
36   * <p>Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard
37   * <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</p>
38   *
39   * <p>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p>
40   *
41   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
42   * @since 2.5
43   */
44  @Mojo(name = "test-aggregate", aggregator = true, requiresDependencyResolution = ResolutionScope.TEST)
45  @Execute(phase = LifecyclePhase.TEST_COMPILE)
46  public class AggregatorTestJavadocReport extends TestJavadocReport {
47  
48      @Inject
49      public AggregatorTestJavadocReport(
50              SiteTool siteTool,
51              ArchiverManager archiverManager,
52              ResourceResolver resourceResolver,
53              RepositorySystem repoSystem,
54              ArtifactHandlerManager artifactHandlerManager,
55              ProjectBuilder mavenProjectBuilder,
56              ToolchainManager toolchainManager) {
57          super(
58                  siteTool,
59                  archiverManager,
60                  resourceResolver,
61                  repoSystem,
62                  artifactHandlerManager,
63                  mavenProjectBuilder,
64                  toolchainManager);
65      }
66  
67      @Override
68      protected boolean isAggregator() {
69          return true;
70      }
71  }