問題タブ [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.

124 問題

0 投票する

0 に答える

70 参照

haskell - Haddock を使用した名前付きドキュメントチャンク

ソースを文書化しようとしていますが、名前付きチャンクに問題があります。

大量のパターン (50 以上) を文書化したい。各説明をコードの近くに置き、すべての説明をヘッダーに集めたい

私は次のことを試しました：

ただし、最初のチャンクのみが表示されます:

Haddock マークアップに何か問題がありますか、それともバグですか?

2015-11-15T20:01:45.190

0 投票する

1 に答える

68 参照

macos - Haskell Platform 7.10.2-a1 にはドキュメントがありませんか?

OS X 10.11.1 を実行している MacBook Pro にHaskell Platform 7.10.2-a1 64bit-signed.pkgをインストールしました。

Safariできれいに表示されました。「ライブラリ」と「Codec.Compression.Zlib」をクリックする Safari can't find the fileと、URLのページが表示されますfile:///Library/Haskell/ghc-7.10.2-x86_64/lib/zlib-0.5.4.2/doc/html/Codec-Compression-Zlib.html

"ghc-pkg" の出力を検索したところ、 , , , , を含むさらに多くの行方不明が見つかりましたvector--syb全部splitでparsec42parallel個QuickCheck。

私は何を間違えましたか？ありがとう！

macos haskell haskell-platform haddock

2015-12-01T19:53:49.850

0 投票する

1 に答える

433 参照

haskell - 行全体を占める Haddock インラインコードスパンを生成する方法

Haddock では、「インラインコード」¹ マークアップは@...@、「コードブロック」マークアップと同じです。

ブロックとして誤解されることなく、インラインコードスパンのみで構成される単一行の Haddock コメントを記述するにはどうすればよいですか? みたいなコメント

ブロックとしてレンダリング

目的のインラインの代わりに

code span

より多くの例が役立つ場合のコンテキストは、BNF 文法を表すデータ型を作成しているため、次のような多くの型があるということです。

この例は、文法に対応しています

そのため、文法は Haddock コメントに埋め込まれています。しかし、Haddock はこれらの@...@コメントをブロックとして解析するため、出力は不必要に高くなり、一部の行に余分なコメントテキストがあると一貫性がなくなります (例: -- ^@double /term/@ – syntax sugar)。

¹ 別名「モノスペース」または「タイプライター」。

haskell haddock

2016-02-01T22:48:48.957

0 投票する

0 に答える

22 参照

haddock - Haddock に、他のパッケージからのハイパーリンク識別子に別のベース URL を使用するように指示します

ハドックのドキュメントを自分のサイトでホストしたいのですが、自分のマシンでそれらを生成すると、次file://の値と型へのリンクが含まれていbaseます。

haddockパッケージ外からの識別子へのリンクに別のベース URL を使用するように指示する方法はありますか?

haddock

2016-04-12T12:44:49.313

0 投票する

1 に答える

953 参照

haskell - Stack Haddock - 依存関係のドキュメントを生成しない

私はハドックを次のように生成しています:

stack haddock --no-haddock-deps

ヘルプからのこのオプションの私の理解:

Enable/disable building Haddocks for dependencies

依存関係に対してハドックを生成しないということです。しかし、そうではありません。次の 2 つの html ファイルが生成されます。

Updating Haddock index for local packages in /myDir/.stack-work/install/x86_64-osx/lts-6.16/7.10.3/doc/index.html Updating Haddock index for local packages and dependencies in /myDir/.stack-work/install/x86_64-osx/lts-6.16/7.10.3/doc/all/index.html

依存関係のドキュメントは必要ありません。私のモジュールのみ。これどうやってするの？

haskell haskell-stack haddock

2016-09-20T10:39:09.253

0 投票する

0 に答える

128 参照