diff --git a/maven-core/src/site/apt/index.apt b/maven-core/src/site/apt/index.apt index ca2e2516ca..ec9d650550 100644 --- a/maven-core/src/site/apt/index.apt +++ b/maven-core/src/site/apt/index.apt @@ -49,7 +49,24 @@ Maven Core * <<>> component ({{{./apidocs/org/apache/maven/project/ProjectBuilder.html}javadoc}}), with its <<>> implementation - ({{{./xref/org/apache/maven/project/DefaultProjectBuilder.html}source}}), + ({{{./xref/org/apache/maven/project/DefaultProjectBuilder.html}source}}), to prepare {{{./apidocs/org/apache/maven/project/MavenProject.html}<<>> descriptor}} from POM files, + + * <<>> component ({{{./apidocs/org/apache/maven/lifecycle/LifecycleExecutor.html}javadoc}}), + with its <<>> implementation({{{/xref/org/apache/maven/lifecycle/DefaultLifecycleExecutor.html}source}}), to plan or execute tasks.\ + on plugin goals execution order: + + * <>: + it is just a consequence of the order obtained during {{{../maven-model-builder/}effective model building}}, + which combines profile activation+injection and inheritance assembly from parents, + + * known limitations are notably that: + + 1. plugin goal execution in a child is usually simply appended (at end): you can't try to insert in the middle of pre-existing inherited executions, + + 2. append happens at plugin level first, then goal level, independently from phases. + This means for example that adding pluginA:goal2 to pre-existing (pluginA:goal1, pluginB:goal) will lead to (pluginA:goal1, pluginA:goal2, pluginB:goal) + + * see effective POM as shown by {{{/plugins/maven-help-plugin/effective-pom-mojo.html}<<>>}} to see the effective plugins then goals order. * <<>> component ({{{./apidocs/org/apache/maven/plugin/MavenPluginManager.html}javadoc}}), with its <<>> implementation diff --git a/maven-plugin-api/src/main/mdo/plugin.mdo b/maven-plugin-api/src/main/mdo/plugin.mdo index ee70ee52ea..5232e6a4ae 100644 --- a/maven-plugin-api/src/main/mdo/plugin.mdo +++ b/maven-plugin-api/src/main/mdo/plugin.mdo @@ -25,8 +25,9 @@ under the License. Plugin descriptor, stored in META-INF/maven/plugin.xml in a plugin's jar artifact. This descriptor is generally generated from plugin sources, using maven-plugin-plugin. -

Notice: this documentation is generated from a Modello model but the code executed is not generated - from this descriptor. Please report if you find anything wrong.

+

Notice: this documentation is generated from a Modello model but the + PluginDescriptor/MojoDescriptor + code executed is not generated from this model. Please report if you find anything wrong this documentation.

]]> diff --git a/maven-plugin-api/src/site/apt/index.apt b/maven-plugin-api/src/site/apt/index.apt index 6eb59556c6..e7a16aebe2 100644 --- a/maven-plugin-api/src/site/apt/index.apt +++ b/maven-plugin-api/src/site/apt/index.apt @@ -25,7 +25,13 @@ Maven Plugin API - The API for plugins - composed of goals implemented by Mojos - development. + The API for plugins - composed of goals implemented by Mojos - development: + + * goal code extends {{{./apidocs/org/apache/maven/plugin/AbstractMojo.html}<<>> base class}} that implements {{{./apidocs/org/apache/maven/plugin/Mojo.html}<<>> interface}}, + + * {{{./apidocs/org/apache/maven/plugin/logging/Log.html}<<>> interface}} provides easy logging for the goal. + + [] A plugin is described in a {{{./plugin.html}<<>> plugin descriptor}}, generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}}. @@ -34,6 +40,6 @@ Maven Plugin API * {{{/developers/mojo-api-specification.html}Mojo API Specification}} - * {{{/plugin-tools/}plugin-tools}} + * {{{/plugin-tools/}Plugin Tools}} that provide {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}} to generate the {{{./plugin.html}<<>> plugin descriptor}} - * {{{/plugin-testing/}plugin-testing}} + * {{{/plugin-testing/}Plugin Testing}} frameworks diff --git a/maven-plugin-api/src/site/site.xml b/maven-plugin-api/src/site/site.xml index 519623c9e7..1cbf42b096 100644 --- a/maven-plugin-api/src/site/site.xml +++ b/maven-plugin-api/src/site/site.xml @@ -32,8 +32,8 @@ - - + +