ocaml - 将 ocamldoc 与包一起使用

标签 ocaml ocamldoc

我有一个 ocamlbuild 项目,它在一个子目录中包含一些文件,并在一个 .mlpack 文件中列出它们。

例如我有一个文件 support/logging.ml,它定义了模块 Support.Logging_tags 文件显示 "support": for-pack(Support)

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

我找到的最新帖子是 ocamldoc generation and packed files从 2011 年开始,它建议使用 ocp-pack 生成一个大型 .ml 文件并将其传递给 ocamldoc。但是,这没有考虑构建顺序,因此生成的模块由于前向引用而无法工作。

处理此问题的最佳方法是什么?

最佳答案

问题在 the following bugreport 中描述.在 ocamldoc 中处理 -pack 需要维护者没有动力执行的实现工作,到目前为止还没有人加紧为此功能贡献补丁。

与此同时,您可以轻松地将 foo.mlpack 文件复制到 foo.odocl 中,生成单独子模块的文档。这只是一个不完美的解决方法,因为文档将讨论 X 而不是 Foo.X,但这是一个最省力的解决方案。

关于ocaml - 将 ocamldoc 与包一起使用,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17368613/

相关文章:

ocaml - 优雅地忽略 OCaml 中的函数

ocaml - 为什么 ocamldoc 在未绑定(bind)的模块上失败?

ocaml - 如何根据模块签名为OCaml生成文档?

compiler-errors - OCaml : Why am I getting this error?

ocaml - 使 ocamlbuild 将 .ml 和 .mli 文件都传递给 ocamldoc

ocaml - 将 Core 绑定(bind)到 ocamldoc

ocaml - Ocaml 中的括号

ocaml - 构造函数的简写

ocaml - 使用 ocaml utop 打印历史列表