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 java.io.File; 22 23 import org.apache.maven.plugins.annotations.LifecyclePhase; 24 import org.apache.maven.plugins.annotations.Mojo; 25 import org.apache.maven.plugins.annotations.Parameter; 26 import org.apache.maven.plugins.annotations.ResolutionScope; 27 28 /** 29 * Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from 30 * {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable 31 * artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the 32 * <code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent 33 * with those generated in the original project itself. 34 * 35 * @since 2.7 36 */ 37 @Mojo( 38 name = "test-resource-bundle", 39 defaultPhase = LifecyclePhase.PACKAGE, 40 requiresDependencyResolution = ResolutionScope.TEST, 41 threadSafe = true) 42 public class TestResourcesBundleMojo extends ResourcesBundleMojo { 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 return TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER; 53 } 54 55 @Override 56 protected File getJavadocDirectory() { 57 return testJavadocDirectory; 58 } 59 60 @Override 61 protected boolean isTest() { 62 return true; 63 } 64 }