net.flexmojos.oss.plugin.report.AsdocReportMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flexmojos-maven-plugin Show documentation

With this maven plugin Flex3/AS3 sources can be compiled into a SWC or SWF package.

There is a newer version: 7.1.1

Show newest version

/**
 * Flexmojos is a set of maven goals to allow maven users to compile, optimize and test Flex SWF, Flex SWC, Air SWF and Air SWC.
 * Copyright (C) 2008-2012  Marvin Froeder 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.flexmojos.oss.plugin.report;

import java.io.File;
import java.util.Locale;

import net.flexmojos.oss.plugin.compiler.AsdocMojo;
import net.flexmojos.oss.util.PathUtil;

/**
 * 
 * Goal which generates documentation from the ActionScript sources.
 * 
 * 
 * @author Marvin Herman Froeder ([email protected])
 * @since 1.0
 * @goal asdoc-report
 * @requiresDependencyResolution compile
 * @phase process-sources
 * @threadSafe
 */
public class AsdocReportMojo
    extends AsdocMojo
{

    /**
     * Specifies the destination directory where asdoc saves the generated HTML files.
     * 
     * @parameter expression="${project.reporting.outputDirectory}/asdoc"
     * @readonly
     * @required
     */
    protected File asdocOutputDirectory;

    /**
     * The description of the AsDoc report.
     * 
     * @parameter expression="${flex.description}" default-value="ASDoc API documentation."
     */
    private String description;

    /**
     * The name of the AsDoc report.
     * 
     * @parameter expression="${flex.name}" default-value="ASDocs"
     */
    private String name;

    public String getDescription( Locale locale )
    {
        return description;
    }

    public String getName( Locale locale )
    {
        return name;
    }

    @Override
    public String getOutput()
    {
        return PathUtil.path( getReportOutputDirectory() );
    }

    public String getOutputName()
    {
        return "asdoc/index";
    }

    public File getReportOutputDirectory()
    {
        return asdocOutputDirectory;
    }

}