3

我有一个带有长元组的 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功能请求,似乎确认当前不支持此功能;我已在其中添加了我的 +1 ——但如果有人有补丁或解决方法,我很感兴趣。)

4

0 回答 0