javadoc：修复

全名：

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

说明：

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

属性：

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

可选参数

姓名 类型 自从 描述
比较版本 String 2.6 将当前代码与使用Clirr Maven 插件进行比较的版本。
请参见defaultSince。
默认值为：(,${project.version})。
默认作者 String 2.6 Javadoc 标记的默认值@author。
如果未指定，user.name将使用系统属性中定义的。
默认自 String 2.6 Javadoc 标记的默认值@since。

默认值为：${project.version}。
默认版本 String 2.6 Javadoc 标记的默认值@version。
默认是$Id: fix-mojo.html 829394 2012-08-19 17:31:42Z hboutemy $，对应一个 SVN关键字。请参阅您的 SCM 以使用其他 SCM 关键字。
编码 String 2.6 读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。
默认值为：${project.build.sourceEncoding}。
排除 String 2.6 逗号分隔不包括 Java 文件，即 **/*Test.java.
修复类评论 boolean 2.6 标记以根据level.
默认值为：true。
fixFieldComment boolean 2.6 标记以根据 level.
默认值为：true。
修复方法评论 boolean 2.6 标记以根据 level.
默认值为：true。
修复标签 String 2.6 用逗号分隔的标签来修复类、接口或方法 Javadoc 注释。可能的值为：
  • all（修复所有 Javadoc 标记）
  • 作者（仅修复 @author 标签）
  • 版本（仅修复 @version 标签）
  • 因为（仅修复 @since 标签）
  • 参数（仅修复 @param 标记）
  • 返回（仅修复 @return 标记）
  • throws（仅修复 @throws 标签）

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


默认值为：protected。
本地存储库 ArtifactRepository 2.6 工件所在的本地存储库，由测试使用。
输出目录 File 2.6 将重写 Java 类的输出目录。
默认值为：${project.build.sourceDirectory}。

参数详情

比较版本：

将当前代码与使用Clirr Maven 插件进行比较的版本。
请参见defaultSince。
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${comparisonVersion}
  • 默认：(,${project.version})

默认作者：

Javadoc 标记的默认值@author。
如果未指定，user.name将使用系统属性中定义的。
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${defaultAuthor}

默认自：

Javadoc 标记的默认值@since。
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${defaultSince}
  • 默认：${project.version}

默认版本：

Javadoc 标记的默认值@version。
默认是$Id: fix-mojo.html 829394 2012-08-19 17:31:42Z hboutemy $，对应一个 SVN关键字。请参阅您的 SCM 以使用其他 SCM 关键字。
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${defaultVersion}

编码：

读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${encoding}
  • 默认：${project.build.sourceEncoding}

不包括：

逗号分隔不包括 Java 文件，即 **/*Test.java.
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${excludes}

修复类评论：

标记以根据level.
  • 类型：boolean
  • 自：2.6
  • 必需：No
  • 表达式：${fixClassComment}
  • 默认：true

修复字段评论：

标记以根据 level.
  • 类型：boolean
  • 自：2.6
  • 必需：No
  • 表达式：${fixFieldComment}
  • 默认：true

修复方法评论：

标记以根据 level.
  • 类型：boolean
  • 自：2.6
  • 必需：No
  • 表达式：${fixMethodComment}
  • 默认：true

修复标签：

用逗号分隔的标签来修复类、接口或方法 Javadoc 注释。可能的值为：
  • all（修复所有 Javadoc 标记）
  • 作者（仅修复 @author 标签）
  • 版本（仅修复 @version 标签）
  • 因为（仅修复 @since 标签）
  • 参数（仅修复 @param 标记）
  • 返回（仅修复 @return 标记）
  • throws（仅修复 @throws 标签）
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${fixTags}
  • 默认：all

力：

强制执行目标，即跳过保修消息（不推荐）。
  • 类型：boolean
  • 自：2.6
  • 必需：No
  • 表达式：${force}

忽略Clirr：

标记是否忽略 Clirr。
  • 类型：boolean
  • 自：2.6
  • 必需：No
  • 表达式：${ignoreClirr}
  • 默认：false

包括：

逗号分隔包括 Java 文件，即 **/*Test.java.
  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${includes}
  • 默认：**/*.java

级别：

指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为：
  • public（仅显示公共类和成员）
  • protected（仅显示公共和受保护的类和成员）
  • 包（显示所有未标记为私有的类和成员）
  • 私有（显示所有类和成员）

  • 类型：java.lang.String
  • 自：2.6
  • 必需：No
  • 表达式：${level}
  • 默认：protected

本地存储库：

工件所在的本地存储库，由测试使用。
  • 类型：org.apache.maven.artifact.repository.ArtifactRepository
  • 自：2.6
  • 必需：No
  • 表达式：${localRepository}

输出目录：

将重写 Java 类的输出目录。
  • 类型：java.io.File
  • 自：2.6
  • 必需：No
  • 表达式：${outputDirectory}
  • 默认：${project.build.sourceDirectory}