javadoc：修复

全名：

org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:fix

说明：

修复项目Java 代码 的 Javadoc 文档和标签。请参阅可以在哪里使用标签。

属性：

  • 需要执行一个 Maven 项目。
  • 需要范围内工件的依赖解析：compile。
  • 自版本：2.6。
  • 在执行自身之前调用生命周期阶段 编译的执行。

可选参数

姓名 类型 自从 描述
比较版本 细绳 2.6 将当前代码与使用Clirr Maven 插件进行比较的版本。
请参见defaultSince。
默认值为：(,${project.version})。
用户属性是：comparisonVersion。
默认作者 细绳 2.6 Javadoc 标记@author的默认值。
如果未指定，将使用系统属性中定义的user.name 。
用户属性是：defaultAuthor。
默认自 细绳 2.6 Javadoc 标记@since的默认值。
默认值为：${project.version}。
用户属性是：defaultSince。
默认版本 细绳 2.6 Javadoc 标记@version的默认值。
默认为$Id: fix-mojo.html 1030385 2018-05-25 09:39:19Z rfscholte $，对应一个SVN 关键字。请参阅您的 SCM 以使用其他 SCM 关键字。
默认值为：$Id: fix-mojo.html 1030385 2018-05-25 09:39:19Z rfscholte $Id。
用户属性是：defaultVersion。
编码 细绳 2.6 读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding，则使用平台默认编码。
默认值为：${project.build.sourceEncoding}。
用户属性是：编码。
排除 细绳 2.6 逗号分隔不包括 Java 文件，即 **/*Test.java。
用户属性是：排除。
修复类评论 布尔值 2.6 标记以根据级别修复类或接口 Javadoc 注释。
默认值为：true。
用户属性是：fixClassComment。
fixFieldComment 布尔值 2.6 标记以根据 级别修复字段 Javadoc 注释。
默认值为：true。
用户属性是：fixFieldComment。
修复方法评论 布尔值 2.6 标记以根据 级别修复方法 Javadoc 注释。
默认值为：true。
用户属性是：fixMethodComment。
修复标签 细绳 2.6 用逗号分隔的标签来修复类、接口或方法 Javadoc 注释。可能的值为：
  • all（修复所有 Javadoc 标记）
  • 作者（仅修复 @author 标签）
  • 版本（仅修复 @version 标签）
  • 因为（仅修复 @since 标签）
  • 参数（仅修复 @param 标记）
  • 返回（仅修复 @return 标记）
  • throws（仅修复 @throws 标签）
  • 链接（仅修复 @link 标记）

默认值为：全部。
用户属性是：fixTags。
力量 布尔值 2.6 强制执行目标，即跳过保修消息（不推荐）。
用户属性是：force。
忽略Clirr 布尔值 2.6 标记是否忽略 Clirr。
默认值为：false。
用户属性是：ignoreClirr。
包括 细绳 2.6 逗号分隔包括 Java 文件，即 **/*Test.java。注意：默认值为 **\/*.java。
默认值为：**\/*.java。
用户属性是：包括。
等级 细绳 2.6 指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为：
  • public （仅显示公共类和成员）
  • protected （仅显示公共和受保护的类和成员）
  • 包 （显示所有未标记为私有的类和成员）
  • 私有 （显示所有类和成员）

默认值为：受保护。
用户属性是：级别。
本地存储库 工件存储库 2.6 工件所在的本地存储库，由测试使用。
用户属性是：localRepository。
输出目录 文件 2.6 将重写 Java 类的输出目录。
默认值为：${project.build.sourceDirectory}。
用户属性是：outputDirectory。
removeUnknownThrows 布尔值 2.6 标记以从未知类中删除 throws 标签。
默认值为：false。
用户属性是：removeUnknownThrows。

参数详情

比较版本：

将当前代码与使用Clirr Maven 插件进行比较的版本。
请参见defaultSince。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：comparisonVersion
  • 默认值：(,${project.version})

默认作者：

Javadoc 标记@author的默认值。
如果未指定，将使用系统属性中定义的user.name 。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：defaultAuthor

默认自：

Javadoc 标记@since的默认值。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：defaultSince
  • 默认值：${project.version}

默认版本：

Javadoc 标记@version的默认值。
默认为$Id: fix-mojo.html 1030385 2018-05-25 09:39:19Z rfscholte $，对应一个SVN 关键字。请参阅您的 SCM 以使用其他 SCM 关键字。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：defaultVersion
  • 默认值：$Id：fix-mojo.html 1030385 2018-05-25 09:39:19Z rfscholte $Id

编码：

读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding，则使用平台默认编码。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：编码
  • 默认值：${project.build.sourceEncoding}

不包括：

逗号分隔不包括 Java 文件，即 **/*Test.java。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：不包括

修复类评论：

标记以根据级别修复类或接口 Javadoc 注释。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：fixClassComment
  • 默认值：真

修复字段评论：

标记以根据 级别修复字段 Javadoc 注释。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：fixFieldComment
  • 默认值：真

修复方法评论：

标记以根据 级别修复方法 Javadoc 注释。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：fixMethodComment
  • 默认值：真

修复标签：

用逗号分隔的标签来修复类、接口或方法 Javadoc 注释。可能的值为：
  • all（修复所有 Javadoc 标记）
  • 作者（仅修复 @author 标签）
  • 版本（仅修复 @version 标签）
  • 因为（仅修复 @since 标签）
  • 参数（仅修复 @param 标记）
  • 返回（仅修复 @return 标记）
  • throws（仅修复 @throws 标签）
  • 链接（仅修复 @link 标记）
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：fixTags
  • 默认值：全部

力：

强制执行目标，即跳过保修消息（不推荐）。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：力

忽略Clirr：

标记是否忽略 Clirr。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：ignoreClirr
  • 默认值：假

包括：

逗号分隔包括 Java 文件，即 **/*Test.java。注意：默认值为 **\/*.java。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：包括
  • 默认值：**\/*.java

级别：

指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为：
  • public （仅显示公共类和成员）
  • protected （仅显示公共和受保护的类和成员）
  • 包 （显示所有未标记为私有的类和成员）
  • 私有 （显示所有类和成员）
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 用户属性：级别
  • 默认值：受保护

本地存储库：

工件所在的本地存储库，由测试使用。
  • 类型：org.apache.maven.artifact.repository.ArtifactRepository
  • 从: 2.6
  • 要求：否
  • 用户属性：localRepository

输出目录：

将重写 Java 类的输出目录。
  • 类型：java.io.File
  • 从: 2.6
  • 要求：否
  • 用户属性：输出目录
  • 默认值：${project.build.sourceDirectory}

删除未知抛出：

标记以从未知类中删除 throws 标签。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 用户属性：removeUnknownThrows
  • 默认值：假