Ocamldoc和开放模块

时间:2016-10-07 15:53:52

标签: ocaml ocamldoc

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

$ ocamldoc -html included1.ml included2.ml

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

$ ocamldoc -html included1.ml included2.ml including.ml

我明白了:

File "including.ml", line 5, characters 5-16:
Error: Unbound module Included1
1 error(s) encountered  

我从ocamldoc documentation看到开放模块完全​​正常,直到没有冲突出现 我该怎么办?

1 个答案:

答案 0 :(得分:2)

模块可以使用其他模块,但是它需要能够看到编译后的接口。因此,在您的情况下,首先需要编译.ml文件以生成.cmi个文件。然后你需要向ocamldoc指出这些文件的位置。所以这样的事情应该做:

ocamlc -c included1.ml
ocamlc -c included2.ml
ocamlc -c -I . including.ml
ocamldoc -html -I . included1.ml included2.ml including.ml

请注意,一般来说,为每个模块创建.mli文件和ocamldoc这些文件而不是.ml文件是一种很好的(基本)做法。