ocamldoc - 云端在线

程序：

您的姓名

ocamldoc - OCaml 文档生成器

概要

奥卡姆文档 [ 选项 ] 文件名 ...

商品描述

OCaml 文档生成器 奥卡姆文档(1) 从特殊文件生成文件
嵌入在源文件中的注释。 使用的评论 奥卡姆文档 是形式 （** ...
*) 并遵循中描述的格式 这款 OCaml 用户的 手册.

奥卡姆文档 可以生成各种格式的文档：HTML、LaTeX、TeXinfo、Unix man
页，和 点(1)依赖图。 此外，用户可以添加自己的自定义生成器。

在这个联机帮助页中，我们使用这个词 element 引用以下任何部分
OCaml 源文件：一个类型声明、一个值、一个模块、一个异常、一个模块类型、一个
类型构造函数、记录字段、类、类类型、类方法、类值或
类继承子句。

配置

以下命令行选项确定生成的文档的格式
由...生成 奥卡姆文档（1）。

附加选项 选择 此 产量 格式
-html 以 HTML 默认格式生成文档。 存储生成的 HTML 页面
在当前目录中，或在指定的目录中 -d 选项。 你可以
通过编辑生成的页面来自定义生成页面的样式 style.css文件 文件，
或通过使用选项提供您自己的样式表 -css样式. 该文件 style.css文件
如果它已经存在，则不会生成。

-乳胶 以 LaTeX 默认格式生成文档。 生成的 LaTeX 文档是
保存在文件中 ocamldoc.out，或在指定的文件中 -o 选项。 该
文档使用样式文件 奥卡姆文档库. 这个文件是在使用时生成的
-乳胶 选项，如果它不存在。 您可以更改此文件以自定义
LaTeX 文档的风格。

-纺织 以 TeXinfo 默认格式生成文档。 生成的 LaTeX 文档是
保存在文件中 ocamldoc.out，或在指定的文件中 -o 选项。

-男子 将文档生成为一组 Unix 手册页。 存储生成的页面
在当前目录中，或在指定的目录中 -d 选项。

-点 为顶层模块生成一个依赖图，格式适合
显示和处理 点（1）。 该 点(1) 工具可从
http://www.research.att.com/sw/tools/graphviz/. 的文本表示
图形被写入文件 ocamldoc.out, 或指定的文件 -o
选项。 用 点 ocamldoc.out 显示它。

-g 文件
动态加载给定的文件（扩展名通常是 .cmo 或 .cma），
定义自定义文档生成器。 如果给定的文件是一个简单的文件并且
当前目录中不存在，则 奥卡姆文档 在自定义中寻找它
生成器默认目录，并在指定的目录中 -i 选项。

-自定义目录
显示自定义生成器默认目录。

-i 目录
将给定的目录添加到查找自定义生成器的路径中。

一般用途总体评估 选项
-d DIR 在目录中生成文件 DIR, 而不是当前目录。

-倾倒 文件
将收集到的信息转储到 文件. 这些信息可以通过 -加载
后续调用中的选项 奥卡姆文档（1）。

-隐藏 模块
在生成的文档中隐藏给定的完整模块名称。 模块 是一个
完整的模块名称列表以逗号 (,) 分隔，没有空格。 为了
实例： 普适，M2.M3.

-inv-合并-ml-mli
合并时颠倒实现和接口的优先级。 全部
实现文件中的元素被保留，并且 -m 选项指示哪些部分
接口文件中的注释与实现中的注释合并
文件。

-保持代码
始终保留值、方法和实例变量的源代码，当
可用的。 给出 .ml 文件时始终保留源代码，但由
给出 .mli 时默认丢弃。 此选项允许源代码
一直保留着。

-加载 文件
加载信息来自 文件, 由 奥卡姆文档 -倾倒。 一些
-加载 可以给出选项。

-m 标志
指定接口和实现之间的合并选项。 标志 可以是一个或
以下几个字符：

d 合并描述

a 合并@author

v 合并@version

l 合并@see

s 合并@since

o 合并@deprecated

p 合并@param

e 合并@raise

r 合并@return

A 合并一切

- 无自定义标签
不允许自定义@-tags。

-不停
保持元素放置在 (**/**) 特别评论。

-o 文件
将生成的文档输出到 文件 而不是 ocamldoc.out. 这个选项是
仅与 -乳胶, -纺织或 -点 选项​​。

-pp 命令
通过预处理器管道源 命令.

-ppx 命令
通过预处理器管道抽象语法树 命令.

-种类 在生成文档之前对顶级模块列表进行排序。

星 删除每行注释中第一个星号 ('*') 之前的空白字符。

-t 标题
使用 VHDL 语言编写 标题 作为生成的文档的标题。

-介绍 文件
使用内容 文件 as 奥卡姆文档 用作介绍的文本（HTML、LaTeX 和
仅限 TeXinfo）。 对于 HTML，该文件用于创建整个“index.html”文件。

-v 详细模式。 显示进度信息。

-版
打印版本字符串并退出。

-vnum 打印短版本号并退出。

-警告错误
对待 奥卡姆文档 警告作为错误。

-隐藏警告
不打印 奥卡姆文档 警告。

-救命 or - 帮帮我
显示简短的使用摘要并退出。

类型检查 选项
奥卡姆文档(1)调用OCaml类型检查器获取类型信息。 以下选项
影响类型检查阶段。 它们具有相同的含义
欧美（1）和 康乐特(1) 命令。

-I 目录
添加 目录 到目录列表搜索已编译的接口文件 (.cmi
文件）。

-无标签
忽略类型中的非可选标签。

-rectypes
允许任意递归类型。 （见 -rectypes 选项 欧美（1）。）

附加选项 发电 HTML 网页
以下选项与 -html 选项​​：

-所有参数
显示函数和方法的完整参数列表。

-css样式 文件名
使用 VHDL 语言编写 文件名 作为层叠样式表文件。

-着色代码
对括在 [ ] 和 \{[ ]\} 中的 OCaml 代码着色，使用颜色来强调
关键字等。如果代码片段在语法上不正确，则没有颜色
补充说。

-仅索引
仅生成索引文件。

-短函子
使用简短的形式来显示函子： 模块 M : 函子 (A:模块) -> 函子
(B:模块2) -> SIG .. end 显示为 模块 M (A:模块) (B:模块2) : SIG ..
end.

附加选项 发电 胶乳 档
以下选项与 -乳胶 选项​​：

-乳胶值前缀 字首
为生成的 LaTeX 文档中的值的标签提供前缀。
默认前缀是空字符串。 您还可以使用选项 -乳胶型-
字首, -乳胶异常前缀, -乳胶模块前缀, -乳胶模块类型前缀,
-latex-class-前缀, -latex 类类型前缀, -latex 属性前缀及 -乳胶-
方法前缀.

例如，当您有一个类型和一个值时，这些选项很有用
一样的名字。 如果不指定前缀，LaTeX 会抱怨multiply
定义的标签。

- 乳胶标题 n,风格
关联样式编号 n 到给定的 LaTeX 切片命令 样式，例如
部分or第. （仅限 LaTeX。）这在包含生成的
文档在另一个 LaTeX 文档中，在给定的切片级别。 默认的
关联为 1 为节，2 为小节，3 为小节，4 为
第 5 段和第 XNUMX 段。

-无标题
抑制生成的文档中的标题。

-诺托克 不生成目录。

-非预告片
在生成的文档中抑制预告片。

-sep文件
为每个顶层模块生成一个 .tex 文件，而不是全局 ocamldoc.out
文件中。

附加选项 发电 泰信信息 档
以下选项与 -纺织 选项​​：

-esc8 转义信息文件中的重音字符。

-信息条目
指定信息目录条目。

-信息部分
指定信息目录的部分。

-无标题
抑制生成的文档中的标题。

-无索引
不要为信息文件建立索引。

-非预告片
在生成的文档中抑制预告片。

附加选项 发电 点 图表
以下选项与 -点 选项​​：

-点颜色 颜色
指定要在生成的点代码中使用的颜色。 生成模块时
依赖， 奥卡姆文档(1) 对模块使用不同的颜色，具体取决于
它们所在的目录。 生成类型依赖时， 奥卡姆文档(1)
对类型使用不同的颜色，具体取决于它们所在的模块
定义。 颜色 是由逗号 (,) 分隔的颜色名称列表，如
红，蓝，绿. 可用的颜色是支持的颜色 点(1) 工具。

-点包括所有
包括所有模块 点(1) 输出，不仅是命令上给出的模块
线或加载 -加载 选项。

-点减少
在输出点之前执行依赖图的传递归约
代码。 如果有很多混乱的传递依赖项，这可能很有用
图。

-点类型
输出描述类型依赖图而不是模块的点代码
依赖图。

附加选项 发电 男子 档
以下选项与 -男子 选项​​：

-人迷你
仅为模块、模块类型、类和类类型生成手册页，而不是
所有元素的页数。

-man-后缀 后缀
设置用于生成的 man 文件名的后缀。 默认为 o，如 列表.o.

-人节 部分
设置用于生成的 man 文件名的节号。 默认值为 3。

使用 onworks.net 服务在线使用 ocamldoc