Maven Compat – Paramdoc

Paramdoc

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

<paramdoc xmlns="http://maven.apache.org/PARAMDOC/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/PARAMDOC/1.0.0 http://maven.apache.org/xsd/paramdoc-1.0.0.xsd">
  <expressions>
    <expression>
      <syntax/>
      <description/>
      <configuration/>
      <cliOptions>
        <key/>
        <value/>
      </cliOptions>
      <apiMethods>
        <key/>
        <value/>
      </apiMethods>
      <deprecation/>
      <ban/>
      <editable/>
    </expression>
  </expressions>
</paramdoc>

paramdoc

The root of a parameter plugin expression document.

Element	Type	Description
`expressions/expression*`	`List<Expression>`	(Many) The list of plugin parameter expressions described by this document.

expression

A plugin parameter expression supported by Maven

Element	Type	Description
`syntax`	`String`	The syntax of the expression
`description`	`String`	The description of what this expression references, and what it's generally used for.
`configuration`	`String`	The place and syntax used to change the value of this expression.
`cliOptions/(key,value)*`	`Properties`	(Many) The command-line switches used to change the value of this expression.
`apiMethods/(key,value)*`	`Properties`	(Many) The programmatic methods used to change the value of this expression.
`deprecation`	`String`	A preferred alternative to this expression, in the case where it's deprecated.
`ban`	`String`	A preferred alternative to this expression, in the case where it's banned from use.
`editable`	`boolean`	Whether the value of this expression can be changed. Default value is: `true`.