1 package org.apache.maven.plugin.plugin;
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.tools.plugin.generator.Generator;
23 import org.apache.maven.tools.plugin.generator.PluginXdocGenerator;
24
25 import java.io.File;
26
27 /**
28 * Generate Xdoc files for the project mojos or goals.
29 *
30 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
31 * @version $Id: XdocGeneratorMojo.java 670417 2008-06-22 21:34:27Z dennisl $
32 * @since 2.0
33 * @goal xdoc
34 */
35 public class XdocGeneratorMojo
36 extends AbstractGeneratorMojo
37 {
38 /**
39 * The directory where the generated Xdoc files will be put.
40 *
41 * @parameter default-value="${project.build.directory}/generated-site/xdoc"
42 */
43 protected File outputDirectory;
44
45 /** {@inheritDoc} */
46 protected File getOutputDirectory()
47 {
48 return outputDirectory;
49 }
50
51 /** {@inheritDoc} */
52 protected Generator createGenerator()
53 {
54 return new PluginXdocGenerator( project );
55 }
56 }