diff --git a/api/maven-api-model/src/main/mdo/maven.mdo b/api/maven-api-model/src/main/mdo/maven.mdo index 2829ffdc225b..1c36e6b724b2 100644 --- a/api/maven-api-model/src/main/mdo/maven.mdo +++ b/api/maven-api-model/src/main/mdo/maven.mdo @@ -93,7 +93,7 @@ modelVersion 4.0.0+ true - Declares to which version of project descriptor this POM conforms. + Declares which version of project descriptor this POM conforms to. String @@ -104,9 +104,9 @@ parent 4.0.0+ - The location of the parent project, if one exists. Values from the parent + Returns the coordinates of the parent project, if one exists. Values from the parent project will be the default for this project if they are left unspecified. The location - is given as a group ID, artifact ID and version. + is given as a group ID, artifact ID, and version. Parent @@ -121,9 +121,12 @@ 3.0.0+ true - A universally unique identifier for a project. It is normal to + Returns a string that defines a collection of related projects. It is recommended to use a fully-qualified package name to distinguish it from other - projects with a similar name (eg. {@code org.apache.maven}). + projects with a similar name (for example, {@code org.apache.maven}). + This form is now required to create a new group ID in Maven Central. + However, older projects did not always follow this convention, + and often use a single word such as jaxen or jdom as the group ID. String @@ -131,24 +134,26 @@ artifactId 3.0.0+ true - The identifier for this artifact that is unique within the group given by the + Returns a string that identifies a collection of versions within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary - distributions, and WARs. + distributions, and WARs. Only one version of an artifact with the same groupId and + artifactId will be added to the classpath. + String version 4.0.0+ true - The current version of the artifact produced by this project. + Returns the current version of the artifact produced by this project. String packaging 4.0.0+ - The type of artifact this project produces, for example {@code jar}, + Returns the type of artifact this project produces, for example {@code jar}, {@code war}, {@code ear}, {@code pom}. @@ -168,17 +173,17 @@ name 3.0.0+ true - The full name of the project. + Returns the full name of the project. String description 3.0.0+ - A detailed description of the project, used by Maven whenever it needs to + Returns a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the website. While this element can be specified as - CDATA to enable the use of HTML tags within the description, it is discouraged to allow - plain text representation. If you need to modify the index page of the generated website, - you are able to specify your own instead of adjusting this text. + CDATA to enable the use of HTML tags within the description, + plain text is preferable. If you need to modify the index page of the generated website, + you can specify your own instead of adjusting this text. String @@ -198,7 +203,7 @@ 4.0.0+ Default value is: {@code true}

@@ -234,14 +239,14 @@ inceptionYear 3.0.0+ true - The year of the project's inception, specified with 4 digits. This value is - used when generating copyright notices as well as being informational. + Returns the year the project started, specified with 4 digits. This value is + used when generating copyright notices. String organization 3.0.0+ - This element describes various attributes of the organization to which the + Returns the organization to which the project belongs. These attributes are utilized when documentation is created (for copyright notices and links). organisation @@ -606,7 +611,7 @@ repositories 4.0.0+ - The lists of the remote repositories for discovering dependencies and + Returns a list of the remote repositories for discovering dependencies and extensions. Repository @@ -616,7 +621,7 @@ pluginRepositories 4.0.0+ - The lists of the remote repositories for discovering plugins for builds and + Returns a list of the remote repositories for discovering plugins for builds and reports. Repository @@ -635,7 +640,7 @@ reporting 4.0.0+ - This element includes the specification of report plugins to use + Returns the specification of report plugins to use to generate the reports on the Maven-generated site. These reports will be run when a user executes {@code mvn site}. All the reports will be included in the navigation bar for browsing. @@ -649,7 +654,7 @@ PluginContainer 3.0.0+ - Contains the plugins information for the project. + Returns the plugins information for the project. plugins @@ -768,10 +773,10 @@ defaultGoal 3.0.0+ - The default goal (or phase in Maven 2) to execute when none is specified for + The default goal to execute when none is specified for the project. Note that in case of a build with subprojects, only the default goal of the top-level - project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3, - multiple goals/phases can be separated by whitespace. + project is relevant, i.e. the default goals of subprojects are ignored. + Multiple goals can be separated by whitespace. String @@ -2063,7 +2068,7 @@ layout 4.0.0+ - The type of layout this repository uses for locating and storing artifacts - + The type of layout this repository uses for locating and storing artifacts — can be {@code legacy} or {@code default}. String @@ -2207,8 +2212,8 @@ 4.0.0+ Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if + The URL where the website is deployed, in the form {@code protocol://hostname/path}. +

The default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site's {@code child.site.url.inherit.append.path="false"}.

]]> @@ -2219,7 +2224,7 @@ 4.0.0+ Default value is: {@code true}

@@ -2264,7 +2269,7 @@ The configuration as DOM object.

-

By default, every element content is trimmed, but starting with Maven 3.1.0, you can add +

By default, every element's content is trimmed. You can add {@code xml:space="preserve"} to elements you want to preserve whitespace.

You can control how child POMs inherit configuration from parent POMs by adding {@code combine.children} or {@code combine.self} attributes to the children of the configuration element:

@@ -2365,7 +2370,7 @@ dependencies - Additional dependencies that this project needs to introduce to the plugin's + Additional dependencies that this project needs to add to the plugin's classloader. 4.0.0+ @@ -2495,7 +2500,7 @@ 4.0.0+ String default - The identifier of this execution for labelling the goals during the build, + Returns the identifier of this execution for labelling the goals during the build, and for matching executions to merge during inheritance and profile injection. @@ -2511,9 +2516,9 @@ int Warning: This is an internal utility property that is only public for technical reasons, - it is not part of the public API. In particular, this property can be changed or deleted without prior + Returns the priority of this execution compared to other executions which are bound to the same phase. +

Warning: This is an internal utility property that is only public for technical reasons. + It is not part of the public API. This property can be changed or deleted without prior notice.

]]> @@ -2521,7 +2526,7 @@ goals 4.0.0+ - The goals to execute with the given configuration. + Returns the goals to execute with the given configuration. String * @@ -2890,29 +2895,29 @@ ActivationProperty 4.0.0+ - This is the property specification used to activate a profile. If the value field - is empty, then the existence of the named property will activate the profile, otherwise it - does a case-sensitive match against the property value as well. + Returns the property specification used to activate a profile. If the value field + is empty, then the existence of the named property will activate the profile. Otherwise it + does a case-sensitive match against the property value. name 4.0.0+ String true - The name of the property to be used to activate a profile. + Returns the name of the property to be used to activate a profile. value 4.0.0+ String - The value of the property required to activate a profile. + Returns the value of the property required to activate a profile. ActivationOS 4.0.0+ - This is an activator which will detect an operating system's attributes in order + Returns an activator which will detect an operating system's attributes in order to activate its profile. @@ -2920,7 +2925,7 @@ 4.0.0+ String - The name of the operating system to be used to activate the profile. This must be an exact match + Returns the name of the operating system to be used to activate the profile. This must be an exact match of the {@code ${os.name}} Java property, such as {@code Windows XP}. @@ -2929,7 +2934,7 @@ 4.0.0+ String - The general family of the OS to be used to activate the profile, such as + Returns the general family of the OS to be used to activate the profile, such as {@code windows} or {@code unix}. @@ -2937,14 +2942,14 @@ arch 4.0.0+ String - The architecture of the operating system to be used to activate the + Returns the architecture of the operating system to be used to activate the profile. version 4.0.0+ String - The version of the operating system to be used to activate the + Returns the version of the operating system to be used to activate the profile. @@ -2952,7 +2957,7 @@ ActivationFile 4.0.0+ - This is the file specification used to activate the profile. The {@code missing} value + Returns the file specification used to activate the profile. The {@code missing} value is the location of a file that needs to exist, and if it doesn't, the profile will be activated. On the other hand, {@code exists} will test for the existence of the file and if it is there, the profile will be activated. @@ -2963,14 +2968,14 @@ missing 4.0.0+ String - The name of the file that must be missing to activate the profile. Please note, that missing and exists + Returns the name of the file that must be missing to activate the profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time. exists 4.0.0+ String - The name of the file that must exist to activate the profile. Please note, that missing and exists + Returns the name of the file that must exist to activate the profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time. @@ -2986,14 +2991,14 @@ configuration 4.1.0+ DOM - The specification for triggering the profile according to the rules of the + Returns the specification for triggering the profile according to the rules of the custom activation type. type 4.1.0+ String - The type (role-hint) of activation which is to be used to activate the + Returns the type (role-hint) of activation which is to be used to activate the profile. @@ -3016,20 +3021,20 @@ String true org.apache.maven.plugins - The group ID of the reporting plugin in the repository. + Returns the group ID of the reporting plugin. artifactId 4.0.0+ String true - The artifact ID of the reporting plugin in the repository. + Returns the artifact ID of the reporting plugin. version 4.0.0+ - The version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitly, + Returns the version of the reporting plugin to be used. If no version is defined explicitly, version is searched in {@code build/plugins} then in {@code build/pluginManagement}. String @@ -3038,7 +3043,7 @@ reportSets 4.0.0+ - Multiple specifications of a set of reports, each having (possibly) different + Returns multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to an {@code execution} in the build. @@ -3087,8 +3092,8 @@ } /** - * @param groupId The group ID of the plugin in the repository - * @param artifactId The artifact ID of the reporting plugin in the repository + * @param groupId the group ID of the plugin in the repository + * @param artifactId the artifact ID of the reporting plugin in the repository * @return the key of the report plugin, ie {@code groupId:artifactId} */ public static String constructKey(String groupId, String artifactId) { @@ -3109,7 +3114,7 @@ id String true - The unique id for this report set, to be used during POM inheritance and profile injection + Returns the unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets. default @@ -3118,7 +3123,7 @@ reports 4.0.0+ true - The list of reports from this plugin which should be generated from this set. + Returns the list of reports from this plugin which should be generated from this set. String * @@ -3149,14 +3154,9 @@ 4.0.0+ String 2.0 - For a plugin project (packaging is {@code maven-plugin}), the minimum version of - Maven required to use the resulting plugin.
- In Maven 2, this was also specifying the minimum version of Maven required to build a - project, but this usage is deprecated in Maven 3 and not checked any more: use - the Maven Enforcer Plugin's - {@code requireMavenVersion} rule instead. - ]]> + Maven required to use the resulting plugin. false @@ -3171,25 +3171,25 @@ groupId 4.0.0+ - The group ID the artifact has moved to. + Returns the group ID the artifact has moved to. String artifactId 4.0.0+ - The new artifact ID of the artifact. + Returns the new artifact ID of the artifact. String version 4.0.0+ - The new version of the artifact. + Returns the new version of the artifact. String message 4.0.0+ - An additional message to show the user about the move, such as the reason. + Returns an additional message to show the user about the move, such as the reason. String @@ -3202,28 +3202,28 @@ groupId 4.0.0+ - The group ID of the extension's artifact. + Returns the group ID of the extension's artifact. true String artifactId 4.0.0+ - The artifact ID of the extension. + Returns the artifact ID of the extension. true String version 4.0.0+ - The version of the extension. + Returns the version of the extension. String configuration 4.1.0+ - The configuration of the extension. + Returns the configuration of the extension. @since Maven 4.0.0 DOM