注意:这个目标应该用作 Maven 报告。
全名:
org.apache.maven.plugins:maven-javadoc-plugin:2.5:aggregate
说明:
属性:
compile
.2.5
.generate-sources
在执行自身之前调用生命周期阶段的执行。姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
输出目录 | File |
2.5 |
指定 javadoc 保存生成的 HTML 文件的目标目录。 见 d 。 默认值为: ${project.build.directory}/apidocs 。 |
报告输出目录 | File |
2.5 |
指定 javadoc 保存生成的 HTML 文件的目标目录。 |
姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
附加选项 | String |
2.3 |
在命令行上设置一个附加的 Javadoc 选项(即 JVM 选项)。例子:
<additionalJOption>-J-Xss128m</additionalJOption>请参阅 Jflag 。 请参阅 vmoptions 。 |
附加参数 | String |
2.5 |
在命令行上设置附加参数。对于包含空格的参数,此值应包含必要的引号。对于自定义 doclet 很有用。 |
总计的 | boolean |
2.5 |
已弃用。{0}。从 2.5 版开始,使用目标javadoc:aggregate 和
javadoc:test-aggregate 代替。默认值为: false 。 |
作者 | boolean |
2.5 |
指定作者文本是否包含在生成的 Javadocs 中。 见 作者 。 默认值为: true 。 |
引导类路径 | String |
2.5 |
指定引导类所在的路径。 请参阅 引导类路径 。 |
引导类路径工件 | BootclasspathArtifact[] |
2.5 |
指定引导类所在的工件。 请参阅 引导类路径 。 例子: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> 请参阅 Javadoc 。 |
底部 | String |
2.5 |
指定要放置在每个输出文件底部的文本。 如果你想使用 html 你必须把它放在一个 CDATA 部分, 例如。 <![CDATA[Copyright 2005, <a
href="http://www.mycompany.com">MyCompany,
Inc.<a>]]> 见 底部 。 默认值为: Copyright � {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved. 。 |
破坏者 | boolean |
2.5 |
使用断句迭代器来确定第一句的结尾。 请参阅 breakiterator 。 从 Java 1.4 开始 。 默认值为: false 。 |
字符集 | String |
2.5 |
指定此文档的 HTML 字符集。如果未指定,则字符集值将是
docencoding 参数的值。请参阅 字符集 。 |
调试 | boolean |
2.1 |
将此设置为“true”以调试 Javadoc 插件。有了这个,提供了“选项”和“文件”文件。 默认值为: false 。 |
描述 | String |
2.1 |
Javadoc 报告的描述。 |
目标目录 | String |
2.1 |
目标目录的名称。 默认值为: apidocs 。 |
文件编码 | String |
2.5 |
指定生成的 HTML 文件的编码。如果未指定,则文档编码值为UTF-8 .
请参阅 文档编码 。 默认值为: ${project.reporting.outputEncoding} 。 |
文档文件子目录 | boolean |
2.5 |
启用“doc-files”目录的深度复制。 请参阅 docfilessubdirs 。 从 Java 1.4 开始 。 请参阅javadocDirectory 。 默认值为: false 。 |
文档集 | String |
2.5 |
指定启动用于生成文档的 doclet 的类文件。 请参阅 doclet 。 |
docletArtifact | DocletArtifact |
2.5 |
指定包含 doclet 起始类文件的工件(使用 -doclet 选项指定)。 请参阅 docletpath 。 例子: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> 请参阅 Javadoc 。 |
docletArtifacts | DocletArtifact[] |
2.1 |
指定包含 doclet 起始类文件的路径的多个工件(使用 -doclet 选项指定)。 请参阅 docletpath 。 例子: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> 请参阅 Javadoc 。 |
docletPath | String |
2.5 |
指定 doclet 起始类文件(使用 -doclet 选项指定)及其依赖的任何 jar 文件的路径。: docletPath 可以包含多个路径,在 Solaris 上用冒号 ( ) 分隔,; 在 Windows 上用分号 ( ) 分隔。请参阅 docletpath 。 |
文件名 | String |
2.5 |
指定要放置在概览摘要文件顶部附近的标题。 见 文档标题 。 默认值为: ${project.name} ${project.version} API 。 |
编码 | String |
2.5 |
指定源文件的编码名称。如果未指定,编码值将是
file.encoding 系统属性的值。请参阅 编码 。 注意 :在 2.4 中,默认值被锁定以 ISO-8859-1 确保复制构建,但在 2.5 中恢复了这一点。默认值为: ${project.build.sourceEncoding} 。 |
excludePackageNames | String |
2.5 |
从 -subpackages 形成的列表中无条件地排除指定的包及其子包。多个包可以用冒号 ( : ) 分隔。请参阅 排除 。 从 Java 1.4 开始 。 |
排除的ocfiles子目录 | String |
2.5 |
排除任何具有给定名称的“doc-files”子目录。可以通过用冒号 ( ) 分隔多个模式来排除它们: 。请参阅 excludeocfilessubdir 。 从 Java 1.4 开始 。 |
扩展目录 | String |
2.5 |
指定扩展类所在的目录。dirlist 中的目录在: Solaris 上用冒号 ( )分隔,; 在 Windows 上用分号 ( ) 分隔。请参阅 extdirs 。 |
失败错误 | boolean |
2.5 |
指定即使出现错误,构建是否会继续。 默认值为: true 。 |
页脚 | String |
2.5 |
指定要放置在每个输出文件底部的页脚文本。 见 页脚 。 |
团体 | Group[] |
2.5 |
将概览页面上的包分成您指定的任何组,每个表一组。包模式可以是任何包名称,也可以是任何包名称的开头,后跟星号 ( * ),意思是“匹配任何字符”。多个模式可以包含在一个组中,方法是用冒号 ( : ) 分隔它们。见 组 。 例子: <groups> <group> <title>Core Packages</title> <packages>org.apache.core</packages> </group> </groups> 请参阅 Javadoc 。 |
标题 | String |
2.5 |
指定要放置在每个输出文件顶部的标题文本。 见 标题 。 |
帮助文件 | String |
2.5 |
指定顶部和底部导航栏中的帮助链接链接到的备用帮助文件路径\文件名的路径。 注意 :可能与 <nohelp/> 冲突。 请参阅 帮助文件 。 |
javadoc目录 | File |
2.1 |
指定要包含在 Javadoc 中的 Javadoc 资源目录(即 package.html、images...)。 可以与 docfilessubdirs
参数一起使用。请参阅docfilessubdirs 。 |
javadoc可执行文件 | String |
2.3 |
设置要使用的 Javadoc Tool 可执行文件的绝对路径。从 2.5 版开始,仅仅一个目录规范就足以让插件分别使用该目录中的“javadoc”或“javadoc.exe”。 |
javadoc版本 | String |
2.3 |
要使用的 Javadoc 工具可执行文件的版本,例如。“1.3”、“1.5”。 |
关键词 | boolean |
2.1 |
将 HTML 元关键字标签添加到每个类的生成文件中。
见 关键字 。 从 Java 1.4.2 开始 。 从 Java 5.0 开始 。 默认值为: false 。 |
链接 | ArrayList |
2.5 |
创建指向现有 javadoc 生成的外部引用类文档的链接。 见 链接 。 |
链接源 | boolean |
2.5 |
创建每个源文件的 HTML 版本(带有行号)并从标准 HTML 文档添加指向它们的链接。 见 链接源 。 从 Java 1.4 开始 。 默认值为: false 。 |
本地存储库 | ArtifactRepository |
2.5 |
工件所在的本地存储库。 |
语言环境 | String |
2.5 |
指定 javadoc 在生成文档时使用的语言环境。 请参阅 语言环境 。 |
最大内存 | String |
2.5 |
指定启动 Javadoc 工具时要使用的最大 Java 堆大小。JVM 将此属性称为-Xmx
参数。示例:“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是:k ,
kb , m , mb , g ,
gb , t , tb . 如果未指定单位,则默认单位为m 。 |
最小内存 | String |
2.5 |
指定启动 Javadoc 工具时要使用的最小 Java 堆大小。JVM 将此属性称为-Xms
参数。示例:“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是:k ,
kb , m , mb , g ,
gb , t , tb . 如果未指定单位,则默认单位为m 。 |
姓名 | String |
2.1 |
Javadoc 报告的名称。 |
没有意见 | boolean |
2.5 |
抑制整个评论正文,包括主要描述和所有标签,只生成声明。 见 无评论 。 从 Java 1.4 开始 。 默认值为: false 。 |
节点不推荐 | boolean |
2.5 |
防止在文档中生成任何已弃用的 API。 请参阅 nodeprecated 。 默认值为: false 。 |
节点precatedlist | boolean |
2.5 |
防止生成包含已弃用 API 列表 (deprecated-list.html) 和导航栏中指向该页面的链接的文件。 请参阅 nodeprecatedlist 。 默认值为: false 。 |
无助 | boolean |
2.5 |
省略每个输出页面顶部和底部导航栏中的帮助链接。 注意 :可能与 <helpfile/> 冲突。 请参阅 无帮助 。 默认值为: false 。 |
无索引 | boolean |
2.5 |
从生成的文档中省略索引。 注意 :可能与 <splitindex/> 冲突。 见 noindex 。 默认值为: false 。 |
非avbar | boolean |
2.5 |
从生成的文档中省略导航栏。 请参阅 nonavbar 。 默认值为: false 。 |
概览 | boolean |
2.4 |
从生成的文档中省略整个概述页面。 注意 :可能与 <overview/> 冲突。 标准 Doclet 无证选项。 默认值为: false 。 |
无限定词 | String |
2.5 |
在输出中的类名之前省略合格的包名。
请参阅 noqualifier 。 从 Java 1.4 开始 。 |
诺斯 | boolean |
2.5 |
从生成的文档中省略与 since 标签关联的“Since”部分。 见 诺辛 。 默认值为: false 。 |
时间戳 | boolean |
2.1 |
抑制时间戳,它隐藏在每个页面顶部附近生成的 HTML 中的 HTML 注释中。 见 nottimestamp 。 从 Java 5.0 开始 。 默认值为: false 。 |
诺特里 | boolean |
2.5 |
从生成的文档中省略类/接口层次结构页面。
见 注 。 默认值为: false 。 |
离线链接 | OfflineLink[] |
2.5 |
此选项是 -link 的变体;它们都为外部引用的类创建指向 javadoc 生成的文档的链接。
见 链接离线 。 例子: <offlineLinks> <offlineLink> <url>http://java.sun.com/j2se/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> 请参阅 Javadoc 。 |
老的 | boolean |
2.5 |
此选项使用 Javadoc 1.1 生成的文档的外观和功能创建文档。 见 1.1 。 默认值为: false 。 |
概述 | File |
2.5 |
指定 javadoc 应从路径/文件名指定的“源”文件中检索概述文档的文本并将其放置在概述页面 (overview-summary.html) 上。 注意 :可能与 <nooverview/> 冲突。 请参阅 概述 。 默认值为: ${basedir}/src/main/javadoc/overview.html 。 |
包头 | String |
2.1 |
指定左上框架的文本。 从 Java 1.4.2 开始 。 |
代理主机 | String |
2.5 |
已弃用。{0}。从 2.4 开始。而不是在
settings.xml . 默认值为: ${settings.activeProxy.host} 。 |
代理端口 | int |
2.5 |
已弃用。{0}。从 2.4 开始。而不是在
settings.xml . 默认值为: ${settings.activeProxy.port} 。 |
安静的 | boolean |
2.5 |
关闭非错误和非警告消息,只留下警告和错误出现,使其更易于查看。 注意:是 Java 1.4.2 中的标准 doclet(请参阅错误 ID 4714350 )。 见 静 。 从 Java 5.0 开始。 默认值为: false 。 |
远程存储库 | List |
2.5 |
工件所在的远程存储库。 |
资源Artifacts | ResourcesArtifact[] |
2.5 |
包含应复制到 Javadoc 输出目录(如样式表、图标等)的资源的工件列表。
例子: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> 请参阅 Javadoc 。 |
串行警告 | boolean |
2.5 |
为缺少的串行标签生成编译时警告。 请参阅 serialwarn 默认值为: false 。 |
显示 | String |
2.5 |
指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为:
默认值为: protected 。 |
跳过 | boolean |
2.5 |
指定是否应跳过 Javadoc 生成。 默认值为: false 。 |
资源 | String |
2.5 |
使 javadoc 能够处理 J2SE v 1.4 源代码中存在的断言所必需的。 见 源 。 从 Java 1.4 开始 。 |
源路径 | String |
2.5 |
指定子包所在的源路径。: 这些路径在 Solaris 上用冒号 ( ) 分隔,; 在 Windows 上用分号 ( ) 分隔。请参阅 源路径 。 |
源标签 | int |
2.1 |
指定每个选项卡在源中占用的空格数。如果源中没有使用制表符,则使用默认空间。 注意: linksourcetab 在 Java 1.4.2 中(请参阅错误 ID
4788919
)。
从 1.4.2 开始 。 从 Java 5.0 开始。 |
拆分索引 | boolean |
2.5 |
将索引文件拆分为多个文件,按字母顺序,每个字母一个文件,再加上一个用于任何以非字母字符开头的索引条目的文件。 注意 :可能与 <noindex/> 冲突。 请参阅 拆分索引 。 默认值为: false 。 |
样式表 | String |
2.5 |
当未指定stylesheetfile参数时,指定要使用的样式表是 maven javadoc 样式表还是 java 的默认样式
表。可能的值:“maven”或“java”。 默认值为: java 。 |
样式表文件 | String |
2.5 |
指定备用 HTML 样式表文件的路径。 请参阅 样式表文件 。 |
子包 | String |
2.5 |
指定将执行 javadoc 的包目录。多个包可以用冒号 ( : ) 分隔。
请参阅 子包 。 从 Java 1.4 开始 。 |
小标签 | String |
2.5 |
指定启动用于生成该标记的文档的标记的类文件。 见 小标签 。 从 Java 1.4 开始 。 |
tagletArtifact | TagletArtifact |
2.1 |
指定包含 taglet 类文件 (.class) 的 Taglet 工件。 请参阅 标记路径 。 例子: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> 请参阅 Javadoc 。 |
tagletArtifacts | TagletArtifact[] |
2.5 |
指定几个包含 taglet 类文件 (.class) 的 Taglet 工件。这些 taglets 类名将被自动检测,因此无需指定它们。 见 小标签 。 请参阅 标记路径 。 例子: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> 请参阅 Javadoc 。 |
标记路径 | String |
2.5 |
指定用于查找 taglet 类文件 (.class) 的搜索路径。: tagletPath 可以包含多个路径,在 Solaris 上用冒号 ( ) 分隔,; 在 Windows 上用分号 ( ) 分隔。请参阅 标记路径 。 从 Java 1.4 开始 。 |
小标签 | Taglet[] |
2.1 |
使 Javadoc 工具能够解释多个 taglet。 见 小标签 。 请参阅 标记路径 。 例子: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> 请参阅 Javadoc 。 |
标签 | Tag[] |
2.5 |
使 Javadoc 工具能够解释文档注释中的简单、单参数自定义块标记标记名。 见 标签 。 从 Java 1.4 开始 。 例子: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> 请参阅Javadoc 。 |
最佳 | String |
2.4 |
指定要放置在每个输出文件顶部的顶部文本。
见6227616 。 从 Java 6.0 开始 |
采用 | boolean |
2.5 |
每个记录的类和包都包括一个“使用”页面。
见 使用 。 默认值为: true 。 |
使用标准 Doclet 选项 | boolean |
2.5 |
指定将
标准 Doclet 提供的选项
用于自定义 doclet。
例子: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>真</useStandardDocletOptions> 默认值为: true 。 |
冗长的 | boolean |
2.5 |
在 javadoc 运行时提供更详细的消息。 见 详细 。 默认值为: false 。 |
版本 | boolean |
2.5 |
在生成的文档中包含版本文本。 见 版本 。 默认值为: true 。 |
窗口标题 | String |
2.5 |
指定要放置在 HTML 标题标签中的标题。 见 窗口标题 。 默认值为: ${project.name} ${project.version} API 。 |
附加选项 :
<additionalJOption>-J-Xss128m</additionalJOption>请参阅 Jflag 。
java.lang.String
2.3
No
${additionalJOption}
附加参数 :
java.lang.String
2.5
No
${additionalparam}
聚合 :
javadoc:aggregate
和
javadoc:test-aggregate
代替。boolean
2.5
No
${aggregate}
false
作者 :
boolean
2.5
No
${author}
true
引导类路径 :
java.lang.String
2.5
No
${bootclasspath}
引导类路径工件 :
<bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
org.apache.maven.plugin.javadoc.options.BootclasspathArtifact[]
2.5
No
${bootclasspathArtifacts}
底部 :
<![CDATA[Copyright 2005, <a
href="http://www.mycompany.com">MyCompany,
Inc.<a>]]>
java.lang.String
2.5
No
${bottom}
Copyright � {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.
破坏器 :
boolean
2.5
No
${breakiterator}
false
字符集 :
java.lang.String
2.5
No
${charset}
调试 :
boolean
2.1
No
${debug}
false
描述 :
java.lang.String
2.1
No
${description}
目标目录 :
java.lang.String
2.1
No
${destDir}
apidocs
文档编码 :
java.lang.String
2.5
No
${docencoding}
${project.reporting.outputEncoding}
文档文件子目录 :
boolean
2.5
No
${docfilessubdirs}
false
文档集 :
java.lang.String
2.5
No
${doclet}
<docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
org.apache.maven.plugin.javadoc.options.DocletArtifact
2.5
No
${docletArtifact}
<docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
org.apache.maven.plugin.javadoc.options.DocletArtifact[]
2.1
No
${docletArtifacts}
文档路径 :
:
docletPath 可以包含多个路径,在 Solaris 上用冒号 ( ) 分隔,;
在 Windows 上用分号 ( ) 分隔。java.lang.String
2.5
No
${docletPath}
文件名 :
java.lang.String
2.5
No
${doctitle}
${project.name} ${project.version} API
编码 :
file.encoding
系统属性的值。ISO-8859-1
确保复制构建,但在 2.5 中恢复了这一点。java.lang.String
2.5
No
${encoding}
${project.build.sourceEncoding}
排除包名称 :
java.lang.String
2.5
No
${excludePackageNames}
java.lang.String
2.5
No
${excludedocfilessubdir}
扩展目录 :
java.lang.String
2.5
No
${extdirs}
失败错误 :
boolean
2.5
No
${maven.javadoc.failOnError}
true
页脚 :
java.lang.String
2.5
No
${footer}
团体 :
*
),意思是“匹配任何字符”。多个模式可以包含在一个组中,方法是用冒号 ( :
) 分隔它们。<groups> <group> <title>Core Packages</title> <packages>org.apache.core</packages> </group> </groups>
org.apache.maven.plugin.javadoc.options.Group[]
2.5
No
${groups}
标题 :
java.lang.String
2.5
No
${header}
帮助文件 :
java.lang.String
2.5
No
${helpfile}
docfilessubdirs
参数一起使用。java.io.File
2.1
No
${basedir}/src/main/javadoc
java.lang.String
2.3
No
${javadocExecutable}
java.lang.String
2.3
No
${javadocVersion}
关键词 :
boolean
2.1
No
${keywords}
false
链接 :
java.util.ArrayList
2.5
No
${links}
链接源 :
boolean
2.5
No
${linksource}
false
本地存储库 :
org.apache.maven.artifact.repository.ArtifactRepository
2.5
No
${localRepository}
语言环境 :
java.lang.String
2.5
No
${locale}
最大内存 :
-Xmx
参数。示例:“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是:k
,
kb
, m
, mb
, g
,
gb
, t
, tb
. 如果未指定单位,则默认单位为m
。java.lang.String
2.5
No
${maxmemory}
最小内存 :
-Xms
参数。示例:“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是:k
,
kb
, m
, mb
, g
,
gb
, t
, tb
. 如果未指定单位,则默认单位为m
。java.lang.String
2.5
No
${minmemory}
名称 :
java.lang.String
2.1
No
${name}
无评论 :
boolean
2.5
No
${nocomment}
false
节点不推荐 :
boolean
2.5
No
${nodeprecated}
false
节点推荐列表 :
boolean
2.5
No
${nodeprecatedlist}
false
没有帮助 :
boolean
2.5
No
${nohelp}
false
无索引 :
boolean
2.5
No
${noindex}
false
非avbar :
boolean
2.5
No
${nonavbar}
false
概述 :
boolean
2.4
No
${nooverview}
false
无限定词 :
java.lang.String
2.5
No
${noqualifier}
鼻子 :
boolean
2.5
No
${nosince}
false
时间戳 :
boolean
2.1
No
${notimestamp}
false
注意 :
boolean
2.5
No
${notree}
false
离线链接 :
<offlineLinks> <offlineLink> <url>http://java.sun.com/j2se/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
org.apache.maven.plugin.javadoc.options.OfflineLink[]
2.5
No
${offlineLinks}
旧 :
boolean
2.5
No
${old}
false
输出目录 :
java.io.File
2.5
Yes
${destDir}
${project.build.directory}/apidocs
概述 :
java.io.File
2.5
No
${overview}
${basedir}/src/main/javadoc/overview.html
包头 :
java.lang.String
2.1
No
${packagesheader}
代理主机 :
settings.xml
.-link
将通过的代理主机。默认为 中设置的活动代理的代理主机settings.xml
,否则获取 pom.xml 中设置的代理配置。java.lang.String
2.5
No
${proxyHost}
${settings.activeProxy.host}
代理端口 :
settings.xml
.-link
将通过的代理端口。默认为 中设置的活动代理的代理端口settings.xml
,否则获取 pom.xml 中设置的代理配置。int
2.5
No
${proxyPort}
${settings.activeProxy.port}
安静 :
boolean
2.5
No
${quiet}
false
远程存储库 :
java.util.List
2.5
No
${project.remoteArtifactRepositories}
报告输出目录 :
java.io.File
2.5
Yes
${project.reporting.outputDirectory}/apidocs
资源工件 :
<resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
org.apache.maven.plugin.javadoc.options.ResourcesArtifact[]
2.5
No
${resourcesArtifacts}
串行警告 :
boolean
2.5
No
${serialwarn}
false
显示 :
java.lang.String
2.5
No
${show}
protected
跳过 :
boolean
2.5
No
${maven.javadoc.skip}
false
来源 :
java.lang.String
2.5
No
${source}
源路径 :
java.lang.String
2.5
No
${sourcepath}
源标签 :
linksourcetab
在 Java 1.4.2 中(请参阅错误 ID
4788919
)。
int
2.1
No
${sourcetab}
拆分索引 :
boolean
2.5
No
${splitindex}
false
样式表 :
java.lang.String
2.5
No
${stylesheet}
java
样式表文件 :
java.lang.String
2.5
No
${stylesheetfile}
子包 :
java.lang.String
2.5
No
${subpackages}
小标签 :
java.lang.String
2.5
No
${taglet}
<taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
org.apache.maven.plugin.javadoc.options.TagletArtifact
2.1
No
${tagletArtifact}
<tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
org.apache.maven.plugin.javadoc.options.TagletArtifact[]
2.5
No
${tagletArtifacts}
标记路径 :
:
tagletPath 可以包含多个路径,在 Solaris 上用冒号 ( ) 分隔,;
在 Windows 上用分号 ( ) 分隔。java.lang.String
2.5
No
${tagletpath}
小标签 :
<taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
org.apache.maven.plugin.javadoc.options.Taglet[]
2.1
No
${taglets}
标签 :
<tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags>
org.apache.maven.plugin.javadoc.options.Tag[]
2.5
No
${tags}
顶部 :
java.lang.String
2.4
No
${top}
使用 :
boolean
2.5
No
${use}
true
使用标准文档选项 :
<docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>真</useStandardDocletOptions>
boolean
2.5
No
${useStandardDocletOptions}
true
详细 :
boolean
2.5
No
${verbose}
false
版本 :
boolean
2.5
No
${version}
true
窗口标题 :
java.lang.String
2.5
No
${windowtitle}
${project.name} ${project.version} API