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 org.apache.maven.plugins.annotations.Execute;
22  import org.apache.maven.plugins.annotations.LifecyclePhase;
23  import org.apache.maven.plugins.annotations.Mojo;
24  import org.apache.maven.plugins.annotations.ResolutionScope;
25  
26  /**
27   * <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar
28   * using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
29   * </p>
30   *
31   * <p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p>
32   *
33   * @since 2.6
34   */
35  @Mojo(
36          name = "aggregate-jar",
37          defaultPhase = LifecyclePhase.PACKAGE,
38          aggregator = true,
39          requiresDependencyResolution = ResolutionScope.COMPILE)
40  @Execute(phase = LifecyclePhase.COMPILE)
41  public class AggregatorJavadocJar extends JavadocJar {
42      @Override
43      protected boolean isAggregator() {
44          return true;
45      }
46  }