問題タブ [ocamldoc]

以下は、test.mliocamldoc スタイルのコメントでコメントされた interface の例です。

コマンドを実行するocamldoc test.mliと、次のエラーが表示されます。

なぜドキュメンテーションジェネレーターはバインドされていないモジュールを気にする必要があるのですか?

ocamldoc で型コンストラクターを参照しようとしています。

例えば：

そして後で、いくつかのドキュメントでコンストラクターの 1 つを参照したいと思います。

ocamldoc は不平を言います:

ocamldoc が対応する型にリンクできるように、型コンストラクターを参照する方法はありますか?

生成したドキュメントにソースコードを含めたい。ocamldocこれは、次のようにコマンドラインで呼び出すと機能しますocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir。ただし、これをと統合するのに問題がありocamlbuildます。

私は次のコードを使用していますmyocamlbuild.ml：

ただし、これには、対応するインターフェイスファイルがないファイルのソースのみが含まれます。ここで説明されていることとは異なり、ファイルが存在する場合にファイルocamlbuildを渡すことを拒否しているように見えます。ocamlbuildを私がやりたいことをするように誘導する方法はありますか？.mlocamldoc.mli

ocamldoc警告が表示されます:

警告: 要素 MyModule.VariantName が見つかりません

{!MyModule.VariantName}ドキュメントのコメントで使用する場合。

ocamldocドクター曰く_

この章では、要素という単語を使用して、OCaml ソース ファイルの次の部分のいずれかを参照します: 型宣言、値、モジュール、例外、モジュール型、型コンストラクター、レコード フィールド、クラス、クラス型、クラス メソッド、クラス値、またはクラス継承句。

後でテキストのフォーマットを説明するとき：

∣ string{! string }  という名前の要素への参照を挿入します。stringは、完全修飾要素名である必要があります (例: ) 。参照される要素の種類は、次の構文を使用して強制できます (さまざまな要素が同じ修飾名を持つ場合に役立ちます) 。Foo.Bar.t{! kind : string }modulemodtypeclassclasstypevaltypeexceptionattributemethodsection

を使用して型コンストラクターを参照できます{! string }か?

要素の種類の最初のグループは、要素の種類の 2 番目のグループにどのように関連していますか?

ocamlfind を使用せずに、スレッドを含むプロジェクトに ocamldoc を使用することは可能ですか? さらに重要なことは、どのように？

-threadまたは-packageocamldoc でサポートされておらず、-I -thread機能しません。

を使用して、私のモジュールのドキュメントを生成しようとしていますocamldoc。しかし、私はCoreライブラリを使用しており、ocamldoc見つからないことに不満を持っています。

この質問のおかげで理由は理解できますが、標準モジュールの解決策については言及されていません。

何か助けはありますか？

私は ocamldoc を使用して私の小さなプロジェクトを文書化しようとしています。
1 つのメイン.mlファイルがあり、opens他の 2 つのファイルがあり.mlます。

うまく動作しますが、インクルードファイルを追加すると、

私はこれを得る：

ocamldoc のドキュメントから、競合が発生しなくなるまで、モジュールを開くことはまったく問題ないことがわかります。
どのように進めればよいですか？