001package org.apache.maven.plugin.plugin;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.plugins.annotations.Mojo;
023import org.apache.maven.plugins.annotations.Parameter;
024import org.apache.maven.tools.plugin.generator.Generator;
025import org.apache.maven.tools.plugin.generator.PluginXdocGenerator;
026
027import java.io.File;
028
029/**
030 * Generate Xdoc files for the project mojos or goals.
031 *
032 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
033 * @version $Id: XdocGeneratorMojo.html 907040 2014-04-27 09:50:12Z hboutemy $
034 * @since 2.0
035 */
036@Mojo( name = "xdoc", threadSafe = true )
037public class XdocGeneratorMojo
038    extends AbstractGeneratorMojo
039{
040    /**
041     * The directory where the generated Xdoc files will be put.
042     */
043    @Parameter( defaultValue = "${project.build.directory}/generated-site/xdoc" )
044    protected File outputDirectory;
045
046    /** {@inheritDoc} */
047    protected File getOutputDirectory()
048    {
049        return outputDirectory;
050    }
051
052    /** {@inheritDoc} */
053    protected Generator createGenerator()
054    {
055        return new PluginXdocGenerator( project );
056    }
057}