View Javadoc
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.plugins.annotations.Mojo;
23  import org.apache.maven.plugins.annotations.Parameter;
24  import org.apache.maven.tools.plugin.generator.Generator;
25  import org.apache.maven.tools.plugin.generator.PluginXdocGenerator;
26  
27  import java.io.File;
28  
29  /**
30   * Generate Xdoc files for the project mojos or goals.
31   *
32   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
33   * @version $Id: XdocGeneratorMojo.html 907040 2014-04-27 09:50:12Z hboutemy $
34   * @since 2.0
35   */
36  @Mojo( name = "xdoc", threadSafe = true )
37  public class XdocGeneratorMojo
38      extends AbstractGeneratorMojo
39  {
40      /**
41       * The directory where the generated Xdoc files will be put.
42       */
43      @Parameter( defaultValue = "${project.build.directory}/generated-site/xdoc" )
44      protected File outputDirectory;
45  
46      /** {@inheritDoc} */
47      protected File getOutputDirectory()
48      {
49          return outputDirectory;
50      }
51  
52      /** {@inheritDoc} */
53      protected Generator createGenerator()
54      {
55          return new PluginXdocGenerator( project );
56      }
57  }