問題タブ [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.
haskell - Haddock: デフォルト クラスのドキュメントに置き換えられた癖のあるインスタンス関数のドキュメント
次の例を検討してください。
haddock を実行すると、関数getとputが表示されますが、MonadState のデフォルトのドキュメントが使用されています。モジュールに独自のドキュメントを含めるにはどうすればよいですか?
(ここcabal haddockでレポを実行することで、私が何を意味するかを確認できます)
haskell - インポートされていないモジュールの関数への Haddock リンク
moduleには、 moduleのメンバーにBリンクする link を含むドキュメントがあります。モジュールでは、モジュールをインポートします。Haddock は、これを へのリンクとしてレンダリングします。つまり、 にある関数ではなく、タイプ(存在しない) を指します。'A.foo'fooAABA.html#t:foo foofooA.html#v:foo
t:Haddockが小文字で始まる変数にリンクするのはなぜですか? それはバグですか？'A.Foo'型またはコンストラクターである可能性があるため、名前空間の問題があります。foo変数は、少なくとももっともらしいと思われるからです。- リンクを偽造する方法はありますか? これをコードサンプルで書いているので、 としてレンダリングする必要があります
foo。アンカーを試しましたが、それらはモジュール名としてレンダリングされ、直接ハイパーリンクの場合、表示されるテキストを制御できません。 - 私はポスト プロセッサを検討しました ( に置き換えます
t:[a-z])v:が、これにはカスタムの Setup.hs が必要であり、問題が発生し、非常に見苦しくなります。 foo変数であると指定するなど、より合理的な動作を得るための Haddock コマンド ライン フラグが見つかりませんでした。- 循環インポートを導入せずに
Atoのインポートを追加することはできません。これは、純粋にドキュメントのために追加するのは下劣です。B
Shake documentationでこの問題に遭遇しています。例としてremoveFilesAfter、正しいリンクが得られません。
haskell - ハドックのアンカーへのリンクにラベルを付けることができますか?
URL にリンクする場合、読者に表示される内容を指定するラベルを提供できます。たとえば、<http://www.haskell.org haskell>リンクテキストに「haskell」が含まれます。残念ながら、ドキュメントはアンカーへのリンクにラベルを付ける明確な方法を提供していません。リンク "Data.FooBar#foo" には、リンク テキストとして "Data.FooBar" が含まれるため、このリンクがアンカーに移動していることは読者には明らかではありません。
私の質問は次のとおりです。ハドックのアンカーへのリンクにラベルを付けるトリックはありますか、それとも不可能ですか?
haskell - c2hs で Haddock を使用するにはどうすればよいですか?
私は c2hs を使用していくつかの haskell バインディングを作成しています。Haddock を使用して、自動生成されたコンストラクターと関数パラメーターを文書化したいと考えています。ただし、c2hs はコメントを無視します。
FFI コードをあまり書かずに、これらのフィールドの Haddock ドキュメントを取得するにはどうすればよいですか?