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