问题标签 [ocamldoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
51 浏览

compilation - #OCaml ocamldoc 生成错误

您好,我正在尝试使用 ocamldoc 生成 ocaml 文档。我正在尝试以下命令:ocamldoc -html alpha.mli -d doc/

但我有这个错误:

0 投票
0 回答
186 浏览

ocaml - 如何使用参数运行 dune build @doc

我有一个使用沙丘的 ocaml 项目。我想使用 Odoc 生成文档。目前,正在运行dune build @doc,但我想将-short-functors选项传递给 Odoc。如何通过沙丘将期权传递给 Odoc?

0 投票
1 回答
90 浏览

function - ocamldoc 是否为函数生成文档?

我正在使用 ocamldoc 来生成我的程序的文档。我的代码还不是特别大,我只有一个函数,但是当我打开 HTML 时,函数文档不会出现在 ocamldoc 生成的任何文件中。

ocamldoc -all-params arbol\ binario.ml用来生成 HTML

我阅读了 ocamldoc 的文档并使用了该标志-all-params,但它也不起作用。我还创建了一个简单的非递归函数,但它是相同的输出。

0 投票
2 回答
72 浏览

ocaml - ocamldoc 无法使用 @param 正确显示参数名称或描述

简单地说,假设我有以下 OCaml 文件,名为test.ml

如果我运行命令ocamldoc -html -all-params -colorize-code test.ml来获取Test模块的文档,我会得到以下结果:

文件

可以看出,对于参数信息,它()作为参数的名称,并且由于某种原因不包括对参数的描述。

我不确定为什么参数名称和描述没有正确显示。

0 投票
1 回答
69 浏览

ocaml - odoc(OCaml 的文档生成器)删除“Stdlib”前缀

我正在使用odoc以及dune来为库生成文档。这是通过以下方式实现的:dune build @doc

但是,这会生成如下签名:

虽然我想要的是:

OCamldoc 过去提供了可以做到这一点的-hide选项。odoc 有类似的东西吗?如果是,如何从沙丘使用它?

Optionnaly,最好有一个指向 Stdlib 的 Format 模块的链接,但这可能要求太多了