問題タブ [haddock]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
371 参照

haskell - {-# OPTIONS_HADDOCK hide #-} はエクスポートされていないモジュールに影響しますか?

Cabal を使用してパッケージ化およびビルドされたライブラリがあり、一部のモジュールInternalが cabal ファイルの .xml に含まれていないとしますExposed-modules。プラグマを指定すると違いはありますか

の上部にありInternal.hsますか、それとも Haddock に従って既に自動的に非表示になっていますか?

違いがあるとすれば、どのような影響がありますか?

0 投票する
0 に答える
247 参照

haskell - カバル ハドックがレンズを見つけられないのはなぜですか?

レンズライブラリを試しているプロジェクトがあります。関数によって生成された関数を確認できるように、ハドック ドキュメントを生成しようとしていmakeClassy TemplateHaskellます。cabal build正常に動作しますが、cabal haddock失敗します

私は何が欠けていますか?

0 投票する
3 に答える
1291 参照

haskell - Haddock ドキュメントに画像を埋め込む方法

ローカルのHaddockドキュメント内に画像を埋め込むにはどうすればよいですか?

たとえばlensパッケージは画像への外部リンクを使用しているだけですが、画像をローカルに保存したいと思います。

(この質問は、メーリング リストの (未回答の) 質問と非常によく似ています)。

0 投票する
2 に答える
354 参照

haskell - Haddockドキュメントに太字のマークアップを埋め込む

Haskellのソースコードをhaddockマークアップで文書化するときに太字のテキストを取得する方法はありますか?強調するための//がありますが、強いために明白なものは何もありません。私はエレガントなハックを望んでいますが、厄介な回避策に落ち着きます...

AfC

0 投票する
1 に答える
17930 参照

haskell - `{-|`で始まるHaskellコメントは一般的にどういう意味ですか?

{- |Haskellの複数行のコメントが、単に。ではなくで始まることがあり{-ます。

コメント内のパイプ文字で始まることは、慣例により何かを意味しますか?

0 投票する
1 に答える
360 参照

haskell - Haddock on record フィールド Haskell

インターフェイスのレコード フィールドにハドックを書き込もうとしています。一部のフィールドのみがエクスポートされるため、それらの一部のみを文書化します。ここでドキュメントページを読みました: http://www.haskell.org/haddock/doc/html/ch03s02.html#id565178

しかし、私はこれを機能させることができないようです。これが私がハドックを書こうとしているセクションです:

データ型のコメントは、生成された haddock に正しく表示されます。ただし、レコードは生成されません。cid、lookup、およびmodifyレコードを生成したいと思います。

前もって感謝します!

完全なソースはここにあります: https://github.com/jcollard/simple-server/blob/master/Network/SimpleServer.hs

0 投票する
1 に答える
533 参照

haskell - Haddock 番号付きリストの続き

ハドックドキュメンテーションツールで番号付きリストを続ける方法は? ハドックの次の行

次の html を生成します。

これにより、番号付けが中断されます。ハドックを HTML でも 3 番目の数字で継続させる方法はありますか、それとも別の方法を試す必要がありますか (>>> は適切な書式設定を提供します。なぜそれを使用したいのですか)?

0 投票する
2 に答える
2673 参照

haskell - HaskellのGHC.Primの「let x = x in x」と「data Float#」の意味は何ですか?

GHC.Prim のモジュールを調べたところ、GHC.Prim のすべてのデータはのdata Float#ようなものなしで定義=A|Bされ、GHC.Prim のすべての関数は として定義されているようgtFloat# = let x = x in xです。

私の質問は、これらの定義が理にかなっているかどうか、およびそれらが何を意味するかです。

以下のように GHC.Prim のヘッダーを確認しました

質問と何らかの関係があると思いますが、誰がそれを説明してくれますか。

0 投票する
0 に答える
109 参照

cabal - cabal: ドキュメントを hsenv の下にインストールする

プロジェクト用の hsenv サンドボックスがありますが、cabal install でライブラリのドキュメントをインストールできません。以下:

パッケージをインストールしますが、ハドック ドキュメントは生成しません (LICENSE などのみが docs ディレクトリにコピーされます)。ビルド ログには以下のみが含まれます。

verbose=3 を使用しても、cabal インストールから有用な情報を取得できません。hsenv 以外では、すべて正常に動作します。これを修正する方法、または少なくともデバッグする方法についてのアイデアはありますか?

0 投票する
1 に答える
699 参照

haskell - Haskell cabal: latex haddock ドキュメントの生成

cabal と haddock を介して API ドキュメントを生成しようとしています。ラテックスにしたい。私もです:

これは最終的に次のように失敗します。

私にできることはありますか、それともハドックに何か問題がありますか?

参考までに、ビルド プロセスがかなり複雑なので、cabal を使用する必要があります (多数のプリプロセッサ、ffi ライブラリなど)。haddock を手動で呼び出すのは本当に面倒です。

ただし、HTML ドキュメントの作成は完全に期待どおりに機能しています。

完全な出力はhttp://pastebin.com/xt6rWqdeにあります。

私は使っている: