问题标签 [ocamldoc]

这是一个示例界面test.mli，带有 ocamldoc 样式的注释：

如果我运行命令ocamldoc test.mli，我会收到以下错误：

为什么文档生成器应该关心未绑定的模块？

我试图在 ocamldoc 中引用类型构造函数。

例如：

稍后我们想参考一些文档中的构造函数之一：

ocamldoc 抱怨：

有没有办法引用类型构造函数，以便 ocamldoc 可以链接到相应的类型？

我想在我生成的文档中包含源代码。当我ocamldoc像这样在命令行上调用时，这有效ocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir：但是，我在将其与ocamlbuild.

我正在使用以下代码myocamlbuild.ml：

但这仅包括没有相应接口文件的文件的源 - 与这里所说的相反，它看起来像ocamlbuild拒绝将.ml文件传递给ocamldoc当有.mli文件存在时。有没有办法哄 ocamlbuild 做我想做的事？

我有a.ml这样的：

所以对于我的模块 A，接口应该只有do_something().

但是，如果我使用ocamldoc -html a.mlsig 模块，尽管模块 sig 声明了交互，但文档仍然公开了模块 A 中的所有函数，例如：

我应该如何使用ocamldoc，以便所有文件都基于module sig？

我收到ocamldoc警告：

警告：未找到元素 MyModule.VariantName

{!MyModule.VariantName}在文档注释中使用时。

ocamldoc医生说_

在本章中，我们使用元素一词来指代 OCaml 源文件的以下任何部分：类型声明、值、模块、异常、模块类型、类型构造函数、记录字段、类、类类型、类方法、类值或类继承子句。

稍后在解释文本格式时：

∣{! string }  插入对名为string的元素的引用。string必须是完全限定的元素名称，例如Foo.Bar.t. 可以使用以下语法强制引用元素的种类（当各种元素具有相同的限定名称时很有用）：{! kind : string }其中kind可以是module, modtype, class, classtype, val, type, exception, attribute,method或section。

我可以使用 引用类型构造函数{! string }吗？

第一类元素与第二类元素的关系如何？

我有一个 ocamlbuild 项目，其中包含子目录中的一些文件，其中包含列出它们的 .mlpack 文件。

例如，我有一个support/logging.ml定义模块的文件Support.Logging。_tags文件"support": for-pack(Support)说。

这一切都构建并运行良好。但是如何使用 ocamldoc 生成文档呢？

我发现的最新帖子是 2011 年的ocamldoc 生成和打包文件，它建议使用ocp-pack生成一个大的 .ml 文件并将其传递给ocamldoc. 但是，这没有考虑构建顺序，因此生成的模块由于前向引用而无法工作。

处理这个问题的最佳方法是什么？

是否可以在不使用 ocamlfind 的情况下将 ocamldoc 用于具有 Threads 的项目？更重要的是，如何？

-thread或者-package不受 ocamldoc 支持，并且-I -thread不起作用。

我有一个庞大的 OCaml 代码库，想从中获得一些类似 UML 的类/模块图，类似于一些Java 逆向工程工具所做的。

这些图不需要是正式的 UML 图，但至少能够看到每个模块签名中定义的函数/类型的名称对于帮助理解 OCaml 代码库非常有用。如果这可以与模块之间的关联相结合，那就更好了。

可以使用ocamldoc吗？我知道它能够生成模块之间的 DOT 依赖图，但我不知道它是否可以生成有关模块中定义的每个类型/函数的信息。

我正在尝试使用ocamldoc. 但是，我使用该Core库并ocamldoc抱怨找不到它。

我明白为什么要感谢这个问题，但它没有提到标准模块的任何解决方案。

有什么帮助吗？

我正在尝试使用 ocamldoc 记录我的一个小项目。
我有一个主.ml文件和opens另外两个.ml文件。

工作得很好，但是当我添加包含文件时，比如

我明白了：

我从ocamldoc 文档中看到打开模块非常好，直到没有发生冲突。
我应该如何进行？