View Javadoc

1   package org.apache.maven.plugin.javadoc;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
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   * Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
28   * using the standard <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>.
29   *
30   * @version $Id: AggregatorTestJavadocJar.java 1385191 2012-09-15 22:04:49Z hboutemy $
31   * @since 2.6
32   */
33  @Mojo( name = "test-aggregate-jar", defaultPhase = LifecyclePhase.PACKAGE, aggregator = true,
34         requiresDependencyResolution = ResolutionScope.TEST )
35  public class AggregatorTestJavadocJar
36      extends TestJavadocJar
37  {
38      @Override
39      protected boolean isAggregator()
40      {
41          return true;
42      }
43  }