これは、Ubuntu Online、Fedora Online、Windows オンライン エミュレーター、MAC OS オンライン エミュレーターなどの複数の無料オンライン ワークステーションの XNUMX つを使用して、OnWorks 無料ホスティング プロバイダーで実行できるコマンド haddock です。
プログラム:
NAME
haddock - 注釈付き Haskell ソース コードのドキュメント ツール
SYNOPSIS
ハドック [オプション] file...
DESCRIPTION
このマニュアルページでは、 ハドック 指図。 広範なドキュメントは、
DVI、PostScript、HTML など、他のさまざまな形式で利用できます。 下記参照。
file Haskell ソース モジュールを含むファイル名です。 で指定されているすべてのモジュール
コマンドラインは一緒に処理されます。 あるモジュールが別のモジュールのエンティティを参照する場合
モジュールが処理されると、ドキュメントはそのエンティティに直接リンクされます。
エンティティが見つからない(たとえば、実行されていないモジュール内にあるなど)
現在のバッチの一部として処理されますが、生成されたバッチにはハイパーリンクされません。
のドキュメントで詳しく説明されています)。 ハドック 実行できなかったすべての識別子をリストした警告を発行します
解決。
モジュールは相互に再帰的であってはなりません。 ハドック 中で泳ぐのは好きではありません
円。
OPTIONS
プログラムは通常のGNUコマンドライン構文に従い、XNUMXつから始まる長いオプションがあります
ダッシュ (「--」)。 オプションの概要を以下に示します。 完全な説明については、を参照してください。
他のドキュメント。
-o DIR, --odir=DIR
出力ファイルを置くディレクトリ
-i FILE, --read-interface=FILE
インターフェースを読み取る FILE.
-D FILE, --ダンプインターフェイス=FILE
これらのモジュールのインターフェースをダンプします FILE.
-l DIR, --lib=DIR
Haddock の補助ファイルの場所
-h, --html
HTML 形式でドキュメントを生成します。 いくつかのファイルが
現在のディレクトリ (または、 -o オプションが与えられます)、以下を含む
以下
index.htmlを
ドキュメントのトップレベルのページ: 使用可能なモジュールのリストが表示されます。
モジュールが階層的である場合、階層を表すインデント。
ハドック.css
生成された HTML で使用されるスタイルシート。 これを自由に変更してください
色やレイアウトを変更したり、
--css オプションを選択します。
モジュール.html
各モジュールの HTML ページ。
ドキュメントインデックス.html, ドキュメントインデックスXX.html
インデックスは XNUMX つに分割されます (関数/コンストラクターと型/クラス、に従って
Haskell 名前空間) をさらにアルファベット順に分割します。
--フーグル
Hoogle の出力
--html-ヘルプ=形式でアーカイブしたプロジェクトを保存します.
mshelp、mshelp2、または devhelp 形式でインデックスと目次を作成します ( -h)
--ソースベース=URL
生成されたドキュメントにソース ファイルへのリンクを含めます。ここで、URL は
ソースファイルが見つかるベース URL。
-s URL、 --ソースモジュール=URL
生成されたドキュメントにソース ファイルへのリンクを含めます。ここで、URL は
各モジュールのソース コード リンク (%{FILE} または %{MODULE} 変数を使用)。
--ソースエンティティ=URL
生成されたドキュメントにソース ファイルへのリンクを含めます。ここで、URL は
各エンティティのソース コード リンク (%{FILE}、%{MODULE}、または %{NAME} 変数を使用)。
--コメントベース=URL
コンテンツページとインデックスページのコメントリンクの URL。
--comments-module=URL
各モジュールのコメント リンクの URL (%{MODULE} 変数を使用)。
--comments-entity=URL
各エンティティのコメント リンクの URL (%{FILE}、%{MODULE}、または %{NAME} を使用)
ヴァース)。
--css =FILE
CSSを使用する FILE 付属のデフォルトのスタイルシートの代わりに ハドック HTML用
出力。 特定のクラスを指定する必要があります。詳細については、デフォルトのスタイルシートを参照してください。
-p FILE, --プロローグ=FILE
プロローグテキストを含むファイルを指定します。
-t TITLE, --title =TITLE
TITLE ドキュメントの各ページのページ見出しとして。 この意志
通常は、文書化されているライブラリの名前です。
タイトルはプレーンな文字列である必要があります (マークアップはしないでください)。
-k NAME, --package =NAME
パッケージ名を指定します(オプション)。
-n, --no-implicit-prelude
Prelude がインポートされているとは想定しないでください
-d, - デバッグ
追加のデバッグ出力を有効にします。
-?, - 助けて
ヘルプを表示します。
-V, - バージョン
表示バージョン。
-v, -詳細
詳細なステータスレポート。
--use-contents=URL
別途生成された HTML コンテンツ ページを使用します。
--gen-content
指定されたインターフェースから HTML コンテンツを生成します。
--use-index=URL
別途生成された HTML インデックスを使用します。
--gen-index
指定されたインターフェイスから HTML インデックスを生成します。
--ignore-all-exports
すべてのモジュールにignore-exports属性があるかのように動作します。
--非表示=モジュール
まるで振る舞う モジュール 非表示属性を持っています。
--use-package=PACKAGE
処理されるモジュールは以下に依存します PACKAGE.
onworks.net サービスを使用してオンラインでハドックを使用する