Paramdoc

Documentation on parameter expressions supported by Maven for use in plugins.

<paramdoc>
  <expressions>
    <expression>
      <syntax/>
      <description/>
      <configuration/>
      <cliOptions/>
      <apiMethods/>
      <deprecation/>
      <ban/>
      <editable/>
    </expression>
  </expressions>
</paramdoc>

paramdoc

The root of a parameter plugin expression document.

Element Description
expressions The list of plugin parameter expressions described by this document.

expression

A plugin parameter expression supported by Maven

Element Description
syntax The syntax of the expression
description The description of what this expression references, and what it's generally used for.
configuration The place and syntax used to change the value of this expression.
cliOptions The command-line switches used to change the value of this expression.
apiMethods The programmatic methods used to change the value of this expression.
deprecation A preferred alternative to this expression, in the case where it's deprecated.
ban A preferred alternative to this expression, in the case where it's banned from use.
editable Whether the value of this expression can be changed. The default value is true.