3

Haddock 用に注釈を付けようとしている、長いタプルを含む Haskell 関数シグネチャがあります。

gssAcceptSecContext ::
    Maybe GssCtxId              -- ^ context_handle
 -> Maybe GssCredId             -- ^ acceptor_cred_handle
 -> GssToken                    -- ^ input_token_buffer
 -> Maybe GssChannelBindings    -- ^ input_chan_bindings

 -> IO (Either GssError           -- failure: error message
      -- success: return values
        (GssCtxId,                -- context_handle
         Maybe GssToken,          -- output_token
         Bool,                    -- continue? (GSS_S_CONTINUE_NEEDED is set)
         GssName,                 -- src_name
         GssOid,                  -- mech_type
         [GssService],            -- ret_flags
         Int,                     -- time_rec
         Maybe GssCredId))        -- delegated_cred_handle

タプル メンバーのコメントを Haddock マークアップ (-- ^以前の引数の型と同様) に変換すると、Haddock は解析エラーで停止します。これは単なる制限であり、それについては何もできないことを示唆するコメントをいくつか見つけました。そうですか?かなり悪いです。ドキュメントと概要バーの両方が画面の端からはみ出し、判読できません。Haddock を満たすためだけに、タプルの代わりに別の型を導入したくはありません。

ありがとう!

(更新: これが現在サポートされていないことを確認するオープンな Haddock機能要求があります。そこに +1 を追加しましたが、誰かがパッチまたは回避策を持っているかどうかに興味があります。)

4

0 に答える 0