2016-10-07 6 views
1

ocamldocを使用して私の小さなプロジェクトを文書化しようとしています。
私は1つのメイン.mlを持っていますopens他2人.mlファイル。Ocamldocとオープンモジュール

$ 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から見ます紛争が発生しなくなるまで。
どうすればいいですか?

答えて

2

モジュールが他のモジュールを使用しても問題ありませんが、コンパイル済みのインターフェイスを表示する必要があります。あなたの場合、最初にファイル.cmiを生成するために.mlファイルをコンパイルする必要があります。次に、これらのファイルがどこにあるかをocamldocに示す必要があります。したがって、このような何かを行う必要があります。一般的に、それはあなたの.mliモジュールの各ドキュメントのファイルとocamldocこれらのではなく、.mlファイルを作成するには良い(基本的な)練習だと

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

注意を。

+1

まあ、同じ答えを書きました:) Btw、 '-I .'はデフォルトでカレントディレクトリを見るので必要ありません。 – ivg

+0

申し訳ありません...「私は必要ではないかもしれませんね」ツールチェインにツールが必要だと思っていますが、どのツールが夢中になったのかは決して覚えていません。 –

+0

ああ、大丈夫...私はそれが外部依存関係だけで、同じディレクトリ内のファイルではなく、リストに含まれていると思った! =)ありがとう! – pimple

関連する問題