帮助:描述

全名

org.apache.maven.plugins:maven-help-plugin:2.1.1:describe

说明

显示 Maven 插件和/或目标(又名 Mojo - Maven 普通旧 Java 对象)的属性列表。

属性

  • 作为聚合器插件执行。
  • 自版本:2.0.

可选参数

姓名 类型 自从 描述
工件 ID String 2.0 要描述的 Maven 插件artifactId
注意:应与groupId参数一起使用。
命令 String 2.1 Maven 命令行之后的单个目标或单个阶段的 Maven 命令:
mvn [options] [<goal(s)>] [<phase(s)>]
细节 boolean 2.1, was full in 2.0.x 此标志指定应提供目标 (Mojo) 信息的详细(详细)列表。
默认值为false
目标 String 2.1, was mojo in 2.0.x 在指定的 Maven 插件中描述的 Mojo 的目标名称。如果指定了这个参数,只会描述对应的目标(Mojo),而不是整个Plugin。
组 ID String 2.0 要描述的 Maven 插件groupId
注意:应与artifactId参数一起使用。
中等的 boolean 2.0.2 此标志指定应给出目标 (Mojo) 信息的中等列表。
默认值为true
最小的 boolean 2.1 此标志指定应给出目标 (Mojo) 信息的最小列表。
默认值为false
输出 File 2.0 可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。
注意:可能是相对路径。
插入 String 2.0 要描述的 Maven 插件。这必须以以下三种方式之一指定:
  1. 插件前缀,即“帮助”
  2. groupId:artifactId,即'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, 即'org.apache.maven.plugins:maven-help-plugin:2.0'

版本 String 2.0 要描述的 Maven 插件version
注意:应与groupId/artifactId 参数一起使用。

参数详情

工件编号

要描述的 Maven 插件artifactId
注意:应与groupId参数一起使用。
  • 类型java.lang.String
  • 2.0
  • 必需No
  • 表达式${artifactId}

命令

Maven 命令行之后的单个目标或单个阶段的 Maven 命令:
mvn [options] [<goal(s)>] [<phase(s)>]
  • 类型java.lang.String
  • 2.1
  • 必需No
  • 表达式${cmd}

详细信息

此标志指定应提供目标 (Mojo) 信息的详细(详细)列表。
  • 类型boolean
  • 2.1, was full in 2.0.x
  • 必需No
  • 表达式${detail}
  • 默认false

目标

在指定的 Maven 插件中描述的 Mojo 的目标名称。如果指定了这个参数,只会描述对应的目标(Mojo),而不是整个Plugin。
  • 类型java.lang.String
  • 2.1, was mojo in 2.0.x
  • 必需No
  • 表达式${goal}

组号

要描述的 Maven 插件groupId
注意:应与artifactId参数一起使用。
  • 类型java.lang.String
  • 2.0
  • 必需No
  • 表达式${groupId}

中等

此标志指定应给出目标 (Mojo) 信息的中等列表。
  • 类型boolean
  • 2.0.2
  • 必需No
  • 表达式${medium}
  • 默认true

最小

此标志指定应给出目标 (Mojo) 信息的最小列表。
  • 类型boolean
  • 2.1
  • 必需No
  • 表达式${minimal}
  • 默认false

输出

可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。
注意:可能是相对路径。
  • 类型java.io.File
  • 2.0
  • 必需No
  • 表达式${output}

插件

要描述的 Maven 插件。这必须以以下三种方式之一指定:
  1. 插件前缀,即“帮助”
  2. groupId:artifactId,即'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, 即'org.apache.maven.plugins:maven-help-plugin:2.0'
  • 类型java.lang.String
  • 2.0
  • 必需No
  • 表达式${plugin}

版本

要描述的 Maven 插件version
注意:应与groupId/artifactId 参数一起使用。
  • 类型java.lang.String
  • 2.0
  • 必需No
  • 表达式${version}