問題タブ [haddock]

javadocと同じように、ハドックのドキュメントをフォーマットしたいと思います。たとえば、HTMLやその他のマークアップを挿入して、JavaScriptやCSSを除外せずに、よりクリーンな出力を取得できるようにします。特に、行を挿入する方法を知りたいです。ドキュメントを壊します。

ありがとう！

Haddockで生成されたモジュールのドキュメントの多く（例Prelude）では、右上に小さなボックスがあり、移植性、安定性、およびメンテナ情報が含まれています。

ソースコードからそのようなモジュールや実験まで、この情報がモジュールの説明の次のような行から生成されていることを確認しました。

これにはいくつかの奇妙なことがあります：

• フィールドはこの順序でのみ機能するように見えます。順序が狂っているフィールドは、モジュールの説明自体の一部として扱われるだけです。これは、ソースファイルの順序が、生成されたドキュメントの順序と逆であるという事実にも関わらずです。

• これらの分野の公式文書を見つけることができませんでした。、という名前のCabalパッケージプロパティがありstability、そのサンプル値は、同等のHaddockフィールドで見た値と一致しますが、それを超えると、何も見つかりませんでした。

したがって、これらのフィールドはどのように使用されることを意図しており、どこにでも文書化されていますか？

特に、私は知りたいです：

• Portabilityおよびの一般的に使用される値の完全なリストStability。このHaskellWikiページにはリストがありますが、このリストの出所を知りたいのですが。

• モジュールがポータブルか非ポータブルかを判断するための基準。特に、 acme-strfryに対するこれらの質問への回答を希望するパッケージはstrfry、glibcでのみ使用可能な関数であるへのFFIバインディングです。パッケージはglibcシステムでのみ動作するため、移植性がありませんか、それともHaskell言語拡張を使用しないため、移植性がありますか？一般的な使用法は後者を意味するようです。

• ソースファイルでフィールドの特定の順序が必要な理由、および生成されたドキュメントの順序とは逆の理由。

私のプロジェクトにはダミーモジュールがあり、その唯一の目的は、ライブラリの残りの部分のHaddockドキュメントを保持することです。実際、このモジュールには何もインポートする必要はありませんが、他のモジュールをインポートしない場合、Haddockは関数名をそれらのモジュールにハイパーリンクしません。

私のモジュールはこのように見えます

プロジェクトをビルドすると、次の警告が表示されます。

インポートを削除または作成した場合、Haddockはそのドキュメントに()ハイパーリンクしません。someFunctionこのようなインポートをそのままにしておくと、誤った警告がたくさん表示されますが、これは気に入らないものです。また、プロジェクト全体でこの種の警告を抑制したくありません。これは、このモジュール以外のモジュールで役立つ可能性があります。

質問：

1. ビルド時にそのような警告なしにハイパーリンクされたHaddock出力を取得するにはどうすればよいですか？
2. ファイルごとに警告を無効にすることは可能ですか？（でグローバルに実行できるようghc-optionsに.cabal）

Haddock は、ドキュメント内の非 ASCII 文字を UTF-8 でエンコードされたソース ファイルに誤って再エンコードしているようです。ドキュメントに数式を含める必要があることがよくありますが、合計 (∑) などの一般的な数学記号を使用できると、はるかに読みやすくなります。

ただし、haddock を使用してファイルを実行すると、これらの記号は空白の四角形になります。Haddockにはオプション--use-unicodeがありますが、実際のドキュメントを壊しながら、関数シグネチャなどの関数矢印をUnicode文字に変換するだけです。

これがから制御できるとさらに良いでしょうcabal haddock！

Haddock バージョン 2.9.4 を使用しています。

この例を見てください：

不思議なことに、エクスポートされていない宣言のdoc-stringは無視されますが、それ以外の場合は構造が正しく取得されます。

誰か手がかりがありますか？ちなみに、viaを呼び出すことcabal haddock --internalは役に立ちませんし、助けにもなりませんhaddock --ignore-all-exports。

それを宣言するものではなく、それをエクスポートするモジュール内のエンティティに Haddock ドキュメントを追加する方法はありますか?

十数個の型を宣言する隠しモジュールと、エンドユーザーが見るはずの部分だけをエクスポートする別のモジュールがあります。非表示のモジュールではなく、公開されたモジュールにドキュメントを配置するのが論理的です。しかし、私はそれを行う方法を理解できません...

Foo私の管理下にないライブラリ モジュールがあるとします。

thingここで、モジュールから再エクスポートする独自のライブラリ モジュールがあるとしFooます。

互換性の理由から、別のファイルをエクスポートしたくありませんthing。ユーザーがとモジュールFoo.thingの両方をインポートした場合、それらが同じになり、名前の衝突が発生しないように、をエクスポートすることを確認したいと思います。FooBarthing

を使用する 3 番目のモジュールがあるとしますBar。

3番目をghciにロードしましょう。

thingモジュールBarに type があることを示す ghci と haddocks の代わりに、 type があると述べたいFoo.Fooと思います。別のものをエクスポートせずにこれを実現する方法はありますか?thingBarthing

Haddockを使い始めたいと思います。主な理由は、私が今書いているものについて、私が（または他の誰かが）素晴らしいHTMLドキュメントを必要としているということではなく、Haskellモジュールにコメントする標準化された方法を教えてくれるからです。そのため、手を汚したいのですが、かなり基本的な問題にぶつかりました。

ソース：

Haddockの呼び出し：

Haddockは標準ライブラリを探す場所を知らないようですが、それは単なる推測です。ドキュメントは「-B」パラメータについて何かを述べていますが、実際にはそれについて多くを説明していません。

私はオンラインで問題を検索しましたが、基本的に「Cabalパッケージを使用すればすべてがあなたに代わって実行されます」と答えられました。ただし、今はCabalを扱いたくないので、Haddockを単独で学習します（Cabalは待つことができます）。問題に対する素晴らしくて簡単な（っぽい）解決策はありますか？

haddock次のコマンドを実行してインストールしようとしましcabal install haddockたが、次の問題が発生します。

この混乱に対処する方法を知っている人はいますか?

私のghcバージョンが7.4.1であることを編集

現在、Haskell で小さなアプリケーションを開発しています。私もすべて文書化しmainました。しかし、cabal haddock --executablesエラーを表示します：

そしてMain.hsそれ自体：

haddockのドキュメントが見つからないのはなぜmainですか?

ghc-7.0.4、cabal-1.10.2.0およびを使用haddock-2.9.2しFedora 17ます。