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.Parameter;
25  import org.apache.maven.plugins.annotations.ResolutionScope;
26  
27  import java.io.File;
28  
29  /**
30   * Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from
31   * {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable
32   * artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the
33   * <code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent
34   * with those generated in the original project itself.
35   *
36   * @since 2.7
37   */
38  @Mojo( name = "test-resource-bundle", defaultPhase = LifecyclePhase.PACKAGE,
39         requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
40  public class TestResourcesBundleMojo
41      extends ResourcesBundleMojo
42  {
43  
44      /**
45       * Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
46       */
47      @Parameter( alias = "javadocDirectory", defaultValue = "${basedir}/src/test/javadoc" )
48      private File testJavadocDirectory;
49  
50      @Override
51      protected String getAttachmentClassifier()
52      {
53          return TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER;
54      }
55  
56      @Override
57      protected File getJavadocDirectory()
58      {
59          return testJavadocDirectory;
60      }
61  
62  }