Question

我有Haskell函数签名，里面有一个长元组，我试图为Haddock注释：

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 feature request似乎确认目前不支持;我已经在那里添加了我的+1 - 但是如果有人有补丁或解决方法，我很感兴趣。）< / p>

Haskell：在Haddock中注释元组

0 个答案: