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>Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard
28 * <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</p>
29 *
30 * <p>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p>
31 *
32 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
33 * @since 2.5
34 */
35 @Mojo(name = "test-aggregate", aggregator = true, requiresDependencyResolution = ResolutionScope.TEST)
36 @Execute(phase = LifecyclePhase.TEST_COMPILE)
37 public class AggregatorTestJavadocReport extends TestJavadocReport {
38 @Override
39 protected boolean isAggregator() {
40 return true;
41 }
42 }