gjdoc-4.8 - 云端在线

程序：

您的姓名

cp-tools - GNU 类路径工具指南

概要

gjdoc [-源路径 路径列表]
[-all[-子包 包：包：...[-排除 pkglist]
[-编码 字符集[-语言环境 姓名[-资源 释放]
[-上市[受保护[-包[-私人的]
[-文档标题 文本[-标题 文本[-页脚 文本[-底部 文本]
[-链接 网址[-链接离线 网址 径[-无限定符 包：包：...]
[-标签路径 路径列表[-taglet 班级名称[-标签 标签规范]
[-用[-链接源[-分割索引[-无索引[-诺特里]
[-版[-作者[-nosince[-添加样式表 文件]
[-d 目标目录]
[包...] [源文件...] [@cmd文件]

gjdoc [-源路径 路径列表]
[-all[-子包 包：包：...[-排除 pkglist]
[-编码 字符集[-语言环境 姓名[-资源 释放]
[-上市[受保护[-包[-私人的]
[-doclet路径 路径列表[-doclet 班级名称]
[包...] [源文件...] [@cmd文件]
[文档选项]

文件 - 帮帮我

文件 - 版

这里只列出最有用的选项； 其余部分见下文。

商品描述

Gjdoc 可以通过两种方式使用：作为一个独立的文档工具，或者作为一个驱动程序
用户指定的 Doclet。

在默认模式下，Gjdoc 将使用标准 Doclet HTML文档 生成一组
HTML 页面。 规范用法是：

gjdoc -s src/java/ -all -d api-docs/

在这里， 源代码/Java/ 是源代码类层次结构的根， -all 意味着所有有效
应处理在此根目录下找到的 Java 文件，并且 api文档/ 是
应放置生成的文档的目录。

要了解有关运行标准 Doclet 以外的 Doclet 的更多信息，请参阅手册。

配置

附加选项 总结 by Type

这是 Gjdoc 和标准 Doclet 的所有选项的摘要，按以下分组
类型。 解释在以下部分。

来源 在 附加选项
-源路径 路径列表 -子包 pkglist -排除 pkglist

来源 格式 附加选项
-资源 释放 -编码 编码 -破坏迭代器

内联 附加选项
-链接 网址 -链接离线 网址 文件 -无限定符 包：包：...

代 附加选项
-作者 -许可证文本 -用 -版 -分割索引 -无索引
-节点不推荐 -nodeprecated列表 -无帮助 -nonavbar
-nosince -诺特里 -上市 受保护 -包 -私人的
-docfiles子目录 -排除docfiles子目录 目录名
-链接源

输出 附加选项
-d -语言环境 姓名 -字符集 字符集 -文档编码 字符集
-有效的html -baseurl 网址

装饰 附加选项
-窗口标题 文本 -文档标题 文本 -标题 文本
-标题 文本 -页脚 文本 -底部 文本
-帮助文件 文件 -样式表文件 文件 -添加样式表 文件
-组 组标题 pkg 模式：pkg 模式：...

标签 附加选项
-标签路径 -taglet 类名 -标签 标签规范

小文件 附加选项
-doclet路径 -doclet 类名

冗长 附加选项
-安静的 -冗长

在线会议 机械/机器 附加选项
-类路径 -引导类路径 -J 虚拟机

选择 这 来源 档 至 工艺

-s 路径列表
-源路径 路径列表
在指定的一个或多个目录中查找源文件。

路径列表 应该是由您的平台路径分隔的一个或多个目录路径
分隔符（通常 : or ;).

如果没有给出这个选项， 文件 将在当前查找源文件
目录。

指定的目录应该是Java包的根目录
系统。 例如，如果您想为包中的类生成文档
foo.bar，您必须指定包含顶级 FOO 子目录，
不是目录 富人/酒吧/ Java 源文件所在的位置。

简写别名 -s 特定于 文件 并且与 Sun 不兼容 文档.

-all
[实验] 处理在下列目录中找到的所有有效 Java 源文件
源路径及其子目录。

这是一个特定于的选项 文件 并且与 Sun 不兼容 文档.

-子包 包：包：...
递归处理给定 Java 包和所有子包中的类。
请注意，多个包名称必须用冒号而不是空格分隔。

-排除 包：包：...
不要递归地处理给定 Java 包和所有子包中的类。
此选项可与 -all or -子包 为了排除
输出中的单个包或包子树。

包...
处理给定 Java 包中的所有类。

源文件...
处理给定 Java 源文件中的类。

指定 此 格式 of 输入 档

-资源 释放
假设源文件针对 Java 平台的给定版本。

释放 应该是格式为 Java 平台发行版的版本号
MAJOR.MINOR，例如 1.4.

此选项当前被忽略，除非如果版本号出现错误
以外 1.2, 1.3 or 1.4 已指定。

-编码 字符集
假设源文件使用编码 字符集.

的例子 字符集 ，那恭喜你， 美国ASCII, ISO 8859 1 or UTF-8.

的语义 字符集 是相同的
java.nio.charset.Charset.forName(字符串).

-破坏迭代器
使用语言环境的 java.text.BreakIterator 而不是内部的第一句
探测器。

默认情况下， 文件 使用内部算法来确定句子的结束位置。 什么时候
给出了此选项，它将改为使用 java.text.BreakIterator 实例为
语言环境给出 -语言环境 （或默认语言环境）。

申请时应指定此选项 文件 以非注释方式注释的源代码
默认首句检测器不起作用的拉丁语言。 对所有人
其他情况下，默认（不使用 BreakIterator）在
撰写本文的时间。

内联 other 配套文档 套数

-链接 网址
创建指向另一个文档集的超链接。

默认情况下， 文件 只会创建指向源集中类的超链接。 用这个
额外创建指向指定类所覆盖类的超链接的选项
文档集。

网址 应该是其他文档集的根 URL。 例如，要添加
GNU 类路径的超链接，指定以下内容：

-链接 http://developer.classpath.org/doc/

-链接 可以多次指定选项。

请注意，指定 -链接 选项将导致每次 gjdoc 时进行 HTTP 访问
调用。 您可以使用 -链接离线 而是避免这种访问。

-链接离线 网址 文件
创建指向另一个文档集的超链接，该文档集也存在于本地文件中
系统。

此选项的工作原理与 -链接, 除了它访问本地文件系统
而不是用于确定链接所涵盖的类的网络
文档集。

使用时 -链接离线 根本无法访问远程文档集，这可以
根据您的网络连接显着加快生成时间。 这
生成的指向文档集的超链接但是指的是远程集，而不是
本地的，以便您无需进一步分发文档
依赖性。

-链接离线 可以多次指定选项。

-无限定符 包：包：...
不要用它们的包名限定给定包中类的名称。

默认情况下，仅当类是
源集或链接的文档集，并以其名称限定
如果不是，则包含包。 您可以使用此选项来强制使用不合格的名称
对于类，即使它们不是文档集的一部分。

例如，通常对 String 类的引用表示为完全限定的
字符串 （除非您使用链接到适当的文档集 -链接)
因为它不是文档集的一部分。 您可以指定 -无限定符
语言 渲染相同的引用，就像 串.

请注意，对于所有不合格的类名，当您放置
在 HTML 文档中将鼠标指针放在它上面。

-无限定符 所有
从所有类名中省略包名限定符。

指定此选项以完全省略包名称限定符，

选择 这 资讯 至 产生

-上市
仅在输出中包含公共类的公共成员。 默认情况下，受保护
班级成员也包括在内。

受保护
在输出中包含公共类的公共或受保护成员。 这是
默认。

-包
包括 public 和 package-private 的 public、protected 和 package-private 成员
类。

-私人的
包括所有类和类成员，无论其访问级别如何。

-分割索引
为每个字母生成一个索引页，而不是一个单一的、单一的索引页。

默认情况下，标准 Doclet 创建的索引包含单个
页。 这适用于小型文档集，但对于大型文档集，您应该
指定此选项。

-nosince
忽略 @自从 javadoc 注释中的标签。

默认情况下，生成的输出包含列出 API 版本的部分
因为当这个标签存在时，有问题的包、类或类成员存在
遭遇。 指定此选项可省略此信息。

-诺特里
不生成任何树页面。

默认情况下，生成的输出包括每个包的一个继承树，并且 - 如果
文档集由多个包组成 - 具有完整继承的页面
树。 指定此选项可省略这些页面的生成。

-无索引
不输出字母索引。

默认情况下，gjdoc 生成所有程序元素的字母索引
文档集（包、类、内部类、构造函数、方法和
字段）。 指定此选项可省略此信息。

-无帮助
不生成帮助页面。

此选项当前被忽略，因为标准 Doclet 不提供帮助页面。

-节点不推荐
不要输出有关已弃用的包、类或类成员的内联信息。

默认情况下，标准 Doclet 添加一个带有弃用的突出显示的段落
每个已弃用程序元素的描述信息。 指定这个
省略此信息的选项。

-nodeprecated列表
不要为已弃用的 API 元素输出摘要页面。

默认情况下，标准 Doclet 生成一个页面，列出所有已弃用的 API 元素
连同弃用说明，其中通常包括弃用原因
和可能的替代方案。 指定此选项可忽略此信息。

-nonavbar
不输出导航栏、页眉和页脚。

默认情况下，每个输出页面都配备了顶部导航栏（其中可能包括
用户指定的标题）和底部导航栏（可能包括用户-
指定的页脚）。 指定此选项可省略此装饰。

-没有意见
从生成的文件中省略所有文档文本并仅输出声明和
程序元素关系。

这个选项在这里是为了与 文档. 如果您打算提取
关于您的项目的信息通过 文件，您应该考虑使用不同的 Doclet
用于您的目的，例如 XmlDoclet。 您还可以使用 Doclet API
直接通过实现一个新的 Doclet。

-链接源
为每个类生成一个带有语法突出显示的源代码的页面。 默认情况下，这
页面未生成。

可以通过单击标有“源”的按钮访问源代码
导航栏，或通过单击构造函数、字段、方法或内部的名称
类文档页面的详细信息部分中的类。

-用
生成带有交叉引用信息的页面。 默认情况下，此页面不
产生。

可以通过单击标记的按钮访问交叉引用信息
导航栏中的“使用”。

“使用”页面列出了文档集中的所有类/接口
扩展/实现有问题的类（类型）； 类型的字段； 方法或
接受该类型参数的构造函数； 返回类型的方法； 和
抛出类型的方法或构造函数。

-作者
在输出中包含作者信息。

指定时，使用指定的作者信息 @作者 javadoc 中的标签
评论被合并到输出中。 默认情况下， @作者 标签被忽略。

-版
在输出中包含版本信息。

指定时，使用指定的版本信息 @版本 javadoc 中的标签
评论被合并到输出中。 默认情况下， @版本 标签被忽略。

-许可证文本
假设每个源文件的第一个注释包含许可证文本，并添加
许可证信息添加到每个生成的类页面的页脚。

这是一个特定于的选项 文件 并且与 Sun 不兼容 文档.

此选项旨在用于源代码
当有法律原因时，通常以样板许可证注释为前缀
用于在文档中包含许可证。

-docfiles子目录
递归复制目录中的所有文件 文档文件 每个包目录的子目录。

通常，只有在 文档文件 子目录被复制而不降序
递归地

-排除docfiles子目录 姓名:姓名：...
不要将某些目录直接复制到 文档文件 子目录时
递归下降。

此选项的参数应该是一个以冒号分隔的目录名称列表。

此选项仅在以下情况下才有意义 -docfiles子目录 也有规定。 在这种情况下，任何
位于正下方的子目录 文档文件 如果列出目录，则省略。

定制版 配套文档 标签

-标签路径 路径列表
搜索 路径列表 加载使用指定的后续 Taglet 类时 -taglet.

路径列表 应该是一个或多个目录或 jar 文件的路径，由您的
平台的路径分隔符（通常是 : or ;).

-taglet 类名
注册一个 Taglet。

类名 应该是实现 Java 类的完全限定名称
com.sun.tools.doclets.Taglet.

Taglet 类将从使用指定的类路径加载 -标签路径从
使用指定的类路径 -类路径 并从默认的类路径。

参见文档 com.sun.tools.doclets.Taglet 了解更多信息。

请注意，对于简单的标签，还有 -标签.

-标签 标签规范
注册一个通用的 Taglet。

格式 标签规范 必须 ： :" ”.

标签名称 是要匹配的标签名称，不带前导@ 符号。

标志 是以下一个或多个字符，其中每个字符指定一个
要识别标签的源代码上下文。

a 所有上下文

c 建设者

f 领域

m 方法

o 简介

p 包

t 类型（类、接口、异常、错误）

X 临时完全禁用 Taglet 的特殊字符。

标头 是要在专用于标记的部分的标题中显示的字符串
问题。

例如，定义一个标签匹配 @cvsid 总体上是可以接受的，
包装和类型页面，并标有标题 CVS ID， 你会
指定：

-tag cvsid:tpo:"CVS ID"

假设一个类 javadoc 注释包含

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

然后 HTML 输出将包含类似

简历编号：
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

运行 其他名称 小文件

-doclet路径 路径列表
搜索 路径列表 为使用指定的 Doclet 加载类时 -doclet.

路径列表 应该是一个或多个目录或 jar 文件的路径，由您的
平台的路径分隔符（通常是 : or ;).

-doclet 班级名称
运行指定的 doclet 而不是标准的 HtmlDoclet。

班级名称 应该是具有公共默认值的类的完全限定名称
构造函数并包含具有以下签名的方法：

导入 com.sun.javadoc.RootDoc;
公共静态布尔启动（RootDoc rootDoc）

Doclet 类将从使用指定的类路径加载 -doclet路径从
使用指定的类路径 -类路径 并从默认的类路径。

开始 方法应该通过以下方式处理 Doclet API 公开的信息 根文档
然后返回 true 成功时， false 失败。

如果您使用的是第三方 doclet，请参阅其文档以获取更多信息
指示。 请注意，对第三方 doclet 的支持是实验性的。 请
报告您遇到的任何问题，或在成功运行时提供反馈
第三方小程序。

这个选项可以被多次指定，在这种情况下所有的 doclet 都会被执行
通过 Doclet API 为每个 Doclet 运行公开相同的信息树。

添加 资讯 至 此 输出

-窗口标题 文本
使用 文本 作为浏览器窗口标题前缀。

指定后，每个页面的浏览器窗口标题将以 文本
而不是默认字符串 产生 API 配套文档.

文本 应该是纯文本（它不应该包含 HTML 标签）。

-文档标题 文本
将概览页面的标题文本设置为 文本.

文本 应该是一个简短的纯文本字符串。

为单个包生成文档时，指定此选项会强制
生成概览页面。

-标题 html文本
地址 html文本 到每个生成页面的右上角。 html文本 通常是
设置为正在记录的项目的名称。

-页脚 html文本
地址 html文本 到每个生成页面的右下角。 html文本 往往是
设置为与 for 相同的值 -标题.

-底部 html文本
地址 html文本 到每个生成页面的最底部，跨越整个页面的宽度
这一页。 指定时， html文本 通常包括版权声明和/或
链接到其他项目页面。

-添加样式表 文件
使用用户指定的样式表扩充默认的 CSS 样式表 文件.

除了默认的样式表之外，每个 HTML 页面都会简单地加载给定的样式表
的，作为最后一个样式表。

请注意，CSS 级联规则适用。 也就是说，您的样式属性只会是
如果它们的级联顺序高于 文件的默认样式。 一个简单的
确保这种情况的方法是声明您的覆盖 ！重要.

看到http://www.w3.org/TR/REC-CSS2/cascade.html#级联顺序>.

-组 标题 通配符:通配符：...
在概览页面上将给定的包安排在一个单独的组中。

第一个参数应该是一个简短的纯文本，用作标题
包组。 第二个参数应该是一个以冒号分隔的包列表
通配符。 该组将由文档集中的所有包组成，其名称
匹配任何给定的通配符。

只有一个通配符， *, 匹配包名中的两个字母
组件和 . 分隔包名称组件。 例如， j*正则表达式 将
匹配包 java.util.regex. 一个更有用的例子是 javax.swing* 匹配
javax.swing 及其所有子包。

可以多次给出此选项。

FIXME：关于组嵌套的信息在这里。

gjdoc -group "核心类" 'java*' \
-group "Swing" 'javax.swing*' \
-group "XML APIs" 'javax.xml*' \
-group "其他扩展" javax* \
...

-概述 文件
添加来自的 XHTML 正文片段 文件 到概览页面。

文件 应该包含一个带有 HTML 的 XHTML 片段 身体 标记为根节点。

此选项可用于提供对整个文档集的描述。

指定时，片段的第一句话将放在表格上方
列出已记录的包，以及指向片段完整副本的链接
放在桌子下面。

为单个包生成文档时，指定此选项会强制
生成概览页面。

-样式表文件 文件
使用 CSS 样式表 文件 而不是默认的 CSS 样式表。

如果您只想覆盖默认样式表的一部分，请使用 -添加样式表
代替。

-标题 文本
已弃用。 使用 -文档标题 文本 代替。

-帮助文件 文件
此选项当前被忽略。

实现时，它将使用 XHTML 片段 文件 帮助页面内容
而不是默认的帮助文本。

控制 此 输出。

-d 目录
将所有输出文件放入 目录 （和子目录）。 目录 将被创建
如果它不存在，包括所有不存在的父目录和所有必需的
子目录。

如果未指定，则输出将放置到当前目录中。

-语言环境 姓名
使用语言环境 姓名 而不是所有目的的默认语言环境。

姓名 应该是形式的区域设置说明符 ll_CC[_VAR] 哪里 ll 是小写的两个-
字母 ISO-639 语言代码， CC 是可选的大写两个字母 ISO-3166 国家/地区
代码，和 VAR 是一个可选的变体代码。 例如， en 指定英语， EN_US
指定美国英语，和 en_US_WIN 指定美国英语的异常变体
地方。

请注意，此选项的语义与构造函数的语义完全对应
上课 java.util.Locale.

此选项当前仅确定使用哪个 Collat​​or 对输出进行排序
元素。 这意味着语言环境仅在您使用非
标识符中的 ASCII 字符。

-字符集 字符集
已弃用。 使用给定的编码覆盖输出 XHTML 文件中的指定编码
by 字符集.

如果未给出此选项，则选择输出 XHTML 中的编码规范
匹配写入文件时使用的编码（用 -文档编码,
或您平台的默认编码）。

语义为 字符集 在此处指定：
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. 出于所有实际目的，
它们与接受字符集参数的其他选项相同。

这个选项在这里是为了与 文档 并且应该避免。

-文档编码 字符集
写入输出文件时使用给定的字符集编码而不是平台的
默认编码。

的例子 字符集 ，那恭喜你， 美国ASCII, ISO 8859 1 or UTF-8.

此选项的语义与类的构造函数的语义完全对应
java.util.Locale.

-有效的html
强制生成有效的 XHTML 代码。 这打破了对传统的兼容性
Javadoc 工具在某种程度上。

如果指定了此选项，锚名称将被修改，以便它们有效
根据 XHTML 1.1 规范。 但是，生成的文档集
使用传统的 Javadoc 工具无法正确链接此选项。 它可以
不过，使用 Gjdoc 链接到就好了。

如果没有这个选项，可执行类成员的锚名称使用传统的
格式，例如：“foo(String,int[])”。 这与传统的兼容
Javadoc 工具，但根据 HTML 4.0 和 XHTML 1.0 和 1.1 规范，
此格式包含非法字符。 圆括号、方括号和逗号
不允许出现在锚名称中。

-baseurl 网址
硬连线一个页面 URL 相对于 网址 进入每个生成的页面。

如果您正在生成仅在特定时间可用的文档
URL，您应该使用此选项来指定此 URL。

这可以帮助避免垃圾邮件发送者使用的某些重定向攻击，并且很有帮助
对于某些 Web 客户端。

冗长 附加选项

-安静的
禁止除警告和错误消息之外的所有输出。

-冗长
非常详细地说明什么 文件 是在做。

此选项当前被忽略。

在线会议 机械/机器 附加选项

太阳的 文档 工具似乎基于 Java语言 因此它似乎在虚拟机上运行
水平。 文件相比之下，它是一个纯 Java 应用程序。

因此， 文件 只能伪造或模拟以下 VM 级选项。

-类路径 路径列表
设置虚拟机 类路径 至 路径列表.

在大多数情况下，您应该使用 -doclet路径 or -标签路径 而不是这个选项。

路径列表 应该是一个或多个目录或 jar 文件的路径，由您的
平台的路径分隔符（通常是 : or ;).

如果没有在包装器级别拦截此选项， 文件 目前伪造它
调用 System.setProperty("java.class.path", 路径列表); 并输出警告。

-引导类路径 路径列表
设置虚拟机 引导类路径 至 路径列表.

如果没有在包装器级别拦截此选项， 文件 输出警告。

-J虚拟机
将任意参数传递给虚拟机 文件 运行。

如果没有在包装器级别拦截此选项， 文件 试图模仿
选项并输出警告。

目前，只有 VM 选项 -D 模拟设置系统属性。

使用 onworks.net 服务在线使用 gjdoc-4.8