これは、Ubuntu Online、Fedora Online、Windows オンライン エミュレーター、または MAC OS オンライン エミュレーターなどの複数の無料オンライン ワークステーションの XNUMX つを使用して、OnWorks 無料ホスティング プロバイダーで実行できるコマンド ocamldoc です。
プログラム：
NAME
ocamldoc - OCaml ドキュメント ジェネレーター
SYNOPSIS
ocamldoc [ オプション ] ファイル名 ...
DESCRIPTION
OCaml ドキュメント ジェネレーター ocamldoc(1) スペシャルからドキュメンテーションを生成する
ソースファイルに埋め込まれたコメント。 が使用したコメント ocamldoc 次の形式です （** ...
*) で説明されている形式に従います。 当学校区の OCaml ユーザーの マニュアル.
ocamldoc ドキュメントをさまざまな形式で作成できます: HTML、LaTeX、TeXinfo、Unix man
ページ、および ドット(1) 依存関係グラフ。 さらに、ユーザーは独自のカスタム ジェネレーターを追加できます。
このマンページでは、 素子 の次の部分のいずれかを参照する
OCaml ソース ファイル: 型宣言、値、モジュール、例外、モジュール型、
型コンストラクタ、レコード フィールド、クラス、クラス型、クラス メソッド、クラス値、または
クラス継承節。
OPTIONS
次のコマンド ライン オプションは、生成されるドキュメントの形式を決定します。
によって生成されます ocamldocとします。
オプション の 選択する 出力 形式でアーカイブしたプロジェクトを保存します．
-html ドキュメントを HTML デフォルト形式で生成します。 生成された HTML ページが保存されます
現在のディレクトリ、または -d オプション。 あなたはできる
生成されたページを編集して、生成されたページのスタイルをカスタマイズする style.cssの ファイル、
またはオプションを使用して独自のスタイルシートを提供することによって -css スタイル。 ファイル style.cssの
すでに存在する場合は生成されません。
-ラテックス LaTeX のデフォルト形式でドキュメントを生成します。 生成された LaTeX ドキュメントは
ファイルに保存された ocamldoc.out、または -o オプション。 ザ·
ドキュメントはスタイル ファイルを使用します ocamldoc.sty. このファイルは、
-ラテックス オプションがまだ存在しない場合。 このファイルを変更してカスタマイズできます
LaTeX ドキュメントのスタイル。
-ティシ ドキュメントを TeXinfo のデフォルト形式で生成します。 生成された LaTeX ドキュメントは
ファイルに保存された ocamldoc.out、または -o オプションを選択します。
-おとこ ドキュメントを Unix man ページのセットとして生成します。 生成されたページが保存されます
現在のディレクトリ、または -d オプションを選択します。
-ドット に適した形式で、トップレベル モジュールの依存関係グラフを生成します。
による表示と処理 ドット（1） の ドット(1) ツールは以下から入手できます。
http://www.research.att.com/sw/tools/graphviz/. のテキスト表現
グラフはファイルに書き込まれます ocamldoc.out、または -o
オプション。 使用する ドット ocamldoc.out それを表示する。
-g file
指定されたファイル (拡張子は通常 .cmo または .cma) を動的にロードします。
カスタム ドキュメント ジェネレータを定義します。 指定されたファイルが単純なファイルであり、
現在のディレクトリに存在しない場合、 ocamldoc カスタムで探します
ジェネレーターのデフォルト ディレクトリ、および -i オプションを選択します。
-カスタムディレクトリ
カスタム ジェネレーターの既定のディレクトリを表示します。
-i ディレクトリにジョブを開始します。
指定されたディレクトリを、カスタム ジェネレーターを探すパスに追加します。
全般 オプション
-d DIR ディレクトリにファイルを生成する DIR、現在のディレクトリではなく。
-投げ捨てる file
収集した情報を次の場所にダンプします file. この情報は、 -負荷
の後続の呼び出しのオプション ocamldocとします。
-隠れる モジュール
生成されたドキュメントで、指定された完全なモジュール名を非表示にします。 モジュール
完全なモジュール名のリストは、空白なしでコンマ (,) で区切られます。 為に
インスタンス： パーベイシブ、M2.M3.
-inv-merge-ml-mli
マージ時に実装とインターフェースの優先順位を逆にします。 全て
実装ファイルの要素は保持され、 -m オプションはどの部品かを示します
インターフェイス ファイルのコメントのうち、実装のコメントとマージされる
ファイル。
-キープコード
値、メソッド、およびインスタンス変数のソース コードを常に保持する場合は、
利用可能。 .ml ファイルが指定された場合、ソース コードは常に保持されますが、
デフォルトは、.mli が指定されたときに破棄されます。 このオプションを使用すると、ソース コードを
常に保管。
-負荷 file
から情報をロード fileによって制作された ocamldoc -投げ捨てる。 いくつか
-負荷 オプションを付けることができます。
-m フラグ
インターフェイスと実装の間のマージ オプションを指定します。 フラグ XNUMXつまたは
次の文字のいくつか:
d マージの説明
a マージ@作成者
v マージ@バージョン
l マージ @see
s マージ @since
o マージ @deprecated
p マージ @param
e マージ@レイズ
r マージ@リターン
A すべてをマージ
-カスタムタグなし
カスタム @ タグを許可しないでください。
-ノンストップ
の後に配置された要素を保持する (**/**) スペシャルコメント。
-o file
生成されたドキュメントを file ocamldoc.out。 このオプションは
と組み合わせてのみ意味があります -ラテックス, -ティシまたは -ドット オプション。
-pp command
ソースをプリプロセッサにパイプする command.
-ppx command
プリプロセッサを介して抽象構文ツリーをパイプする command.
-選別 ドキュメントを生成する前に、最上位モジュールのリストを並べ替えます。
-出演者 コメントの各行の最初のアスタリスク ('*') まで空白文字を削除します。
-t タイトル
タイトル 生成されたドキュメントのタイトルとして。
-イントロ file
使用内容 file as ocamldoc 導入として使用するテキスト (HTML、LaTeX および
TeXinfo のみ)。 HTML の場合、このファイルは「index.html」ファイル全体を作成するために使用されます。
-v 詳細モード。 進捗情報を表示します。
-バージョン
バージョン文字列を出力して終了します。
-vnum 短いバージョン番号を印刷して終了します。
-警告-エラー
扱う ocamldoc エラーとしての警告。
-警告を隠す
印刷しない ocamldoc 警告。
-助けて or - 助けて
短い使用法の概要を表示して終了します。
型チェック オプション
ocamldoc(1) OCaml 型チェッカーを呼び出して型情報を取得します。 以下のオプション
型チェック フェーズに影響します。 それらは、
オカムク（1）と オカムロプト（1）コマンド。
-I ディレクトリにジョブを開始します。
追加 ディレクトリにジョブを開始します。 ディレクトリのリストへ コンパイルされたインターフェイス ファイル (.cmi) を検索します
ファイル）。
-ノーラベル
型のオプションではないラベルを無視します。
-rectypes
任意の再帰型を許可します。 (参照してください -rectypes オプション オカムク（1）。）
オプション の 生成 HTML ページ
次のオプションは、 -html オプション：
-すべてのパラメータ
関数とメソッドのパラメーターの完全なリストを表示します。
-css スタイル ファイル名
ファイル名 カスケード スタイル シート ファイルとして。
-色付けコード
[ ] と \{[ ]\} で囲まれた OCaml コードを色分けして強調する
コードの断片が構文的に正しくない場合、色は表示されません。
追加された。
-インデックスのみ
インデックス ファイルのみを生成します。
-ショートファンクター
ファンクターを表示するには、短い形式を使用します。 モジュール M : ファンクタ (A:モジュール) -> ファンクタ
(B:モジュール 2) -> SIG .. end として表示されます モジュール M (A:モジュール) (B:モジュール 2) : SIG ..
end.
オプション の 生成 ラテックス ファイル
次のオプションは、 -ラテックス オプション：
-ラテックス値プレフィックス 接頭辞
生成された LaTeX ドキュメントの値のラベルに使用するプレフィックスを指定します。
デフォルトのプレフィックスは空の文字列です。 オプションも使えます -ラテックスタイプ-
接頭辞, -latex-例外プレフィックス, -latex-モジュールプレフィックス, -latex-module-type-prefix,
-ラテックスクラスプレフィックス, -latex-class-type-prefix, -ラテックス属性プレフィックス, -ラテックス-
メソッド接頭辞.
これらのオプションは、たとえば、型と値がある場合に役立ちます。
同名。 プレフィックスを指定しない場合、LaTeX は乗算について文句を言います
定義されたラベル。
-ラテックスタイトル n、スタイル
準スタイル番号 n 指定された LaTeX セクション化コマンドに 、例えば
orサブセクション. (LaTeX のみ。) これは、生成された
特定のセクション レベルで、別の LaTeX ドキュメント内のドキュメント。 デフォルト
関連は、セクションの場合は 1、サブセクションの場合は 2、サブサブセクションの場合は 3、サブセクションの場合は 4 です。
パラグラフとサブパラグラフの 5。
-ヘッダーなし
生成されたドキュメントでヘッダーを抑制します。
-notoc 目次を生成しません。
-予告なし
生成されたドキュメントでトレーラーを抑制します。
-sepfiles
グローバルではなく、トップレベル モジュールごとに XNUMX つの .tex ファイルを生成します。 ocamldoc.out
ファイルにソフトウェアを指定する必要があります。
オプション の 生成 テクスインフォ ファイル
次のオプションは、 -ティシ オプション：
-esc8 Info ファイルのアクセント付き文字をエスケープします。
-情報エントリ
Info ディレクトリ エントリを指定します。
-情報セクション
Info ディレクトリのセクションを指定します。
-ヘッダーなし
生成されたドキュメントでヘッダーを抑制します。
-noindex
Info ファイルのインデックスを作成しません。
-予告なし
生成されたドキュメントでトレーラーを抑制します。
オプション の 生成 ドット グラフ
次のオプションは、 -ドット オプション：
-ドットカラー 色
生成されたドット コードで使用する色を指定します。 モジュール生成時
依存関係、 ocamldoc(1) モジュールに応じて、異なる色を使用します。
それらが存在するディレクトリ。 型の依存関係を生成するとき、 ocamldoc(1)
それらが含まれているモジュールに応じて、タイプに異なる色を使用します
定義された。 色 次のように、コンマ (,) で区切られた色名のリストです。
赤、青、緑. 利用可能な色は、 ドット（1）ツール。
-ドットインクルードすべて
すべてのモジュールを ドット(1) コマンドで指定されたモジュールだけでなく、出力
行またはロードされた -負荷 オプションを選択します。
-ドット縮小
ドットを出力する前に、依存グラフの推移的な縮小を実行します
コード。 これは、乱雑な推移的な依存関係が多数ある場合に役立ちます
グラフ。
-ドットタイプ
モジュールの代わりに型依存グラフを記述するドットコードを出力する
依存グラフ。
オプション の 生成 man ファイル
次のオプションは、 -おとこ オプション：
-マンミニ
代わりに、モジュール、モジュール タイプ、クラス、およびクラス タイプのマニュアル ページのみを生成します。
すべての要素のページ数。
-人接尾辞 サフィックス
生成された man ファイル名に使用されるサフィックスを設定します。 デフォルトは o です。 リスト.o.
-男のセクション
生成された man ファイル名に使用されるセクション番号を設定します。 デフォルトは 3 です。
onworks.net サービスを使用して ocamldoc をオンラインで使用する
