maven-core/src/main/resources/META-INF/maven/plugin-expressions/project.paramdoc.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<paramdoc xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 ../../../../../../../maven-plugin-parameter-documenter/target/generated-site/xsd/paramdoc-1.0.0.xsd ">
<expressions>
  <expression>
    <syntax>project.distributionManagementArtifactRepository</syntax>
    <configuration>
      <![CDATA[
<distributionManagement>
  <!-- use the following if you're not using a snapshot version. -->
  <repository>
    <id>repo</id>
    <name>Repository Name</name>
    <url>scp://host/path/to/repo</url>
  </repository>
  <!-- use the following if you ARE using a snapshot version. -->
  <snapshotRepository>
    <id>repo</id>
    <name>Repository Name</name>
    <url>scp://host/path/to/repo</url>
  </snapshotRepository>
</distributionManagement>
    ]]></configuration>
    <description> This is the ArtifactRepository used to deploy artifacts built by this
      Maven.
    </description>
  </expression>
  <expression>
    <syntax>project.artifact</syntax>
    <configuration>
      <![CDATA[
<groupId>project.group</groupId>
<artifactId>project-artifact</artifactId>
<version>0.0.0.0</version>
<packaging>type</packaging>
    ]]></configuration>
    <description> This is the Artifact instance created from the essential project
      attributes: groupId, artifactId, version, and packaging (with a default packaging of
      'jar').
    </description>
  </expression>
  <expression>
    <syntax>project.parent</syntax>
    <configuration>
      <![CDATA[
<parent>
  <groupId>project.group</groupId>
  <artifactId>project-artifact</artifactId>
  <version>0.0.0.0</version>
</parent>
    ]]></configuration>
    <description> This is the MavenProject instance for the parent of the current POM.
    </description>
  </expression>
  <expression>
    <syntax>project.file</syntax>
    <description> This is the File instance that refers to the location of the current POM on
      disk.
    </description>
  </expression>
  <expression>
    <syntax>project.artifacts</syntax>
    <configuration>
      <![CDATA[
<dependencies>
  ...
</dependencies>
    ]]></configuration>
    <description>
      <![CDATA[
      This is a set of Artifact instances resolved from the set of dependencies for
      the current project.
      
      NOTE: This will likely contain much more than the direct dependencies of the 
      current POM, since Maven uses transitive, or chained, dependency resolution.
    ]]></description>
  </expression>
  <expression>
    <syntax>project.parentArtifact</syntax>
    <configuration>
      <![CDATA[
    <parent>
      <groupId>project.group</groupId>
      <artifactId>project-artifact</artifactId>
      <version>0.0.0.0</version>
    </parent>
    ]]></configuration>
    <description> This is the Artifact instance for the parent of the current POM.
    </description>
  </expression>
  <expression>
    <syntax>project.pluginArtifacts</syntax>
    <configuration>
      <![CDATA[
<build>
  <plugins>
    ...
  </plugins>
</build>
    ]]></configuration>
    <description>
      <![CDATA[
      This is the list of Artifact instances for plugins used in the current build
      for this project.
      
      NOTE: This list may contain plugin Artifacts which are implied by the current POM's
      packaging and the lifecycle phase being built.
    ]]></description>
  </expression>
  <expression>
    <syntax>project.remoteArtifactRepositories</syntax>
    <configuration>
      <![CDATA[
<repositories>
  ...
</repositories>
    ]]></configuration>
    <description>
      <![CDATA[
      This is a list of ArtifactRepository instances used to resolve the Artifacts associated
      with the current POM.
      
      NOTE: This list will contain entries for repositories specified by ancestor POMs, including
      the default built-in super-POM, which is the parent of all POMs.
    ]]></description>
  </expression>
  <expression>
    <syntax>project.pluginArtifactRepositories</syntax>
    <configuration>
      <![CDATA[
<pluginRepositories>
  ...
</pluginRepositories>
    ]]></configuration>
    <description>
      <![CDATA[
      This is a list of ArtifactRepository instances used to resolve the Artifacts associated
      with plugins used in building the current POM.
      
      NOTE: This list will contain entries for repositories specified by ancestor POMs, including
      the default built-in super-POM, which is the parent of all POMs.
    ]]></description>
  </expression>
  <expression>
    <syntax>project.attachedArtifacts</syntax>
    <description>
      <![CDATA[
      This is a list of attachments to the main artifact produced by building the current POM.
      Attachments are derived works, based on the main build process, such as an ejb-client jar,
      project sources jar, etc.
    ]]></description>
  </expression>
</expressions>
</paramdoc>