Package org.apache.karaf.tooling.commands

Class GenerateHelpMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.karaf.tooling.commands.GenerateHelpMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="commands-generate-help",
      defaultPhase=GENERATE_RESOURCES,
      requiresDependencyResolution=RUNTIME,
      inheritByDefault=false,
      threadSafe=true)
public class GenerateHelpMojo
extends org.apache.maven.plugin.AbstractMojo

Generates help documentation for Karaf commands

Field Summary

Fields

Modifier and Type	Field	Description
protected String	classLoader	The classloader to use for loading the commands.
protected String	format	The output format
protected boolean	includeHelpOption	Includes the --help command output in the generated documentation
protected org.apache.maven.project.MavenProject	project	The maven project.
protected File	targetFolder	The output folder

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateHelpMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

targetFolder

@Parameter(defaultValue="${project.build.directory}/docbkx/sources")
protected File targetFolder

The output folder

format

@Parameter(defaultValue="docbx")
protected String format

The output format

classLoader

@Parameter(defaultValue="project")
protected String classLoader

The classloader to use for loading the commands. Can be "project" or "plugin"

includeHelpOption

@Parameter(defaultValue="true")
protected boolean includeHelpOption

Includes the --help command output in the generated documentation

project

@Parameter(defaultValue="${project}")
protected org.apache.maven.project.MavenProject project

The maven project.

Constructor Detail

GenerateHelpMojo

public GenerateHelpMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException