diff --git a/maven-plugin-api/pom.xml b/maven-plugin-api/pom.xml index ff42e1165f..0fe8e8a421 100644 --- a/maven-plugin-api/pom.xml +++ b/maven-plugin-api/pom.xml @@ -62,10 +62,20 @@ under the License. src/main/mdo/lifecycle.mdo + src/main/mdo/plugin.mdo 1.0.0 + + maven-jar-plugin + + + org/apache/maven/plugin/descriptor/model + org/apache/maven/plugin/descriptor/model/**/* + + + diff --git a/maven-plugin-api/src/main/mdo/plugin.mdo b/maven-plugin-api/src/main/mdo/plugin.mdo new file mode 100644 index 0000000000..a6bf84f51d --- /dev/null +++ b/maven-plugin-api/src/main/mdo/plugin.mdo @@ -0,0 +1,425 @@ + + + + plugin + PluginDescriptor + META-INF/maven/plugin.xml in a plugin's jar artifact. + This descriptor is generally generated from plugin sources, using + maven-plugin-plugin. + ]]> + + + package + org.apache.maven.plugin.descriptor.model + + + + + PluginDescriptor + 1.0.0 + plugin.xml file.]]> + + + description + 1.0.0 + Description of the plugin. + String + + + groupId + 1.0.0 + + String + + + artifactId + 1.0.0 + + String + + + version + 1.0.0 + + String + + + goalPrefix + 1.0.0 + + String + + + isolatedRealm + 1.0.0 + + boolean + false + + + inheritedByDefault + 1.0.0 + + boolean + true + + + mojos + 1.0.0 + + MojoDescriptor + * + + + + + + + MojoDescriptor + 1.0.0 + + + + goal + true + 1.0.0 + String + + + + description + 1.0.0 + String + + + + implementation + 1.0.0 + String + + + + language + 1.0.0 + String + java + + + + phase + 1.0.0 + String + + + + executePhase + 1.0.0 + String + + + + executeGoal + 1.0.0 + String + + + + executeLifecycle + 1.0.0 + String + + + + requiresDependencyResolution + 1.0.0 + String + compile, runtime, test, provided + ]]> + + + requiresDependencyCollection + 1.0.0 + String + compile, runtime, test, provided. + ]]> + + + requiresDirectInvocation + 1.0.0 + boolean + + + + requiresProject + 1.0.0 + boolean + + true + + + requiresReports + 1.0.0 + boolean + + + + requiresOnline + 1.0.0 + boolean + + + + aggregator + 1.0.0 + boolean + + + + inheritedByDefault + 1.0.0 + boolean + + true + + + threadSafe + 1.0.0 + boolean + + + + instantiationStrategy + 1.0.0 + String + per-lookup + per-lookup + + + executionStrategy + 1.0.0 + String + once-per-session, always + + + since + 1.0.0 + String + the version when the Mojo was added to the API. Similar to Javadoc since. + + + deprecated + 1.0.0 + String + the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated. + + + configurator + 1.0.0 + String + + + + composer + 1.0.0 + String + + + + parameters + 1.0.0 + + + Parameter + * + + + + configuration + 1.0.0 + + + Configuration + * + + + + requirements + 1.0.0 + + + Requirement + * + + + + + + + Parameter + 1.0.0 + A phase mapping definition. + + + name + true + 1.0.0 + String + + + + alias + 1.0.0 + String + + + + type + 1.0.0 + String + + + + required + 1.0.0 + boolean + + + + editable + 1.0.0 + boolean + true + + + + implementation + 1.0.0 + String + + + + description + 1.0.0 + String + + + + deprecated + 1.0.0 + String + + + + + + + Configuration + 1.0.0 + A parameter configuration. + + + expression + true + 1.0.0 + String + Parameter expression. + + + defaultValue + 1.0.0 + String + + + + + + + Requirement + 1.0.0 + + + + role + true + 1.0.0 + String + + + + roleHint + 1.0.0 + String + + + + fieldName + true + 1.0.0 + String + + + + + + + Dependency + 1.0.0 + + + + groupId + true + 1.0.0 + String + + + + artifactId + true + 1.0.0 + String + + + + type + 1.0.0 + String + + + + version + 1.0.0 + String + + + + + + diff --git a/maven-plugin-api/src/site/apt/index.apt b/maven-plugin-api/src/site/apt/index.apt index 2f20a04547..6c04123b6c 100644 --- a/maven-plugin-api/src/site/apt/index.apt +++ b/maven-plugin-api/src/site/apt/index.apt @@ -10,6 +10,9 @@ Maven Plugin API The API for plugins - Mojos - development. + A plugin is described in a {{{./plugin.html}<<>> plugin descriptor}}, + generally generated from plugin sources using {{{/plugins/maven-plugin-plugin/}maven-plugin-plugin}}. + * See Also * {{{/developers/mojo-api-specification.html}Mojo API Specification}} diff --git a/maven-plugin-api/src/site/site.xml b/maven-plugin-api/src/site/site.xml index 157190add9..9594af1bfd 100644 --- a/maven-plugin-api/src/site/site.xml +++ b/maven-plugin-api/src/site/site.xml @@ -31,6 +31,7 @@ +