对包使用ocamldoc

Question

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

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

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

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

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

Answer 1

这是我现在在Makefile中使用的解决方案。它确实起作用了，并且交叉引用到支持模块中：

doc:
    ocp-pack -o support.ml.tmp support/logging.ml support/common.ml support/utils.ml support/basedir.ml support/qdom.ml support/system.ml
    echo '(** General support code; not 0install-specific *)' > support.ml
    cat support.ml.tmp >> support.ml
    rm support.ml.tmp
    $(OCAMLBUILD) 0install.docdir/index.html
    rm support.ml

这很麻烦，因为：

• 您必须按构建顺序列出support.ml文件，手动
• 生成文件将添加文档注释以供支持(否则，它将采用第一个子模块的描述，这是您不需要的)

Answer 2

这个问题在the following bugreport中有描述。在ocamldoc中处理-pack需要一个维护人员没有动力去执行的实现工作，而且到目前为止还没有人为这个特性贡献补丁。

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