Merge pull request #5073 from IntersectMBO/coot/mux-api-haddocks

Added haddocks to MiniProtocol type
IntersectMBO · Feb 10, 2025 · 29a7a57 · 29a7a57
2 parents a933425 + 5d314ee
commit 29a7a57
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ouroboros-network-framework/src/Ouroboros/Network/Mux.hs b/ouroboros-network-framework/src/Ouroboros/Network/Mux.hs
@@ -235,9 +235,14 @@ type OuroborosBundleWithMinimalCtx (mode :: Mux.Mode) peerAddr bytes m a b =
 data MiniProtocol (mode :: Mux.Mode) initiatorCtx responderCtx bytes m a b =
      MiniProtocol {
        miniProtocolNum    :: !MiniProtocolNum,
+       -- ^ mini-protocol number
        miniProtocolStart  :: !Mux.StartOnDemandOrEagerly,
+       -- ^ strategy for starting responder side; initiator side is always
+       -- started using `StartEagerly`.
        miniProtocolLimits :: !MiniProtocolLimits,
+       -- ^ mini-protocol limits
        miniProtocolRun    :: !(RunMiniProtocol mode initiatorCtx responderCtx bytes m a b)
+       -- ^ mini-protocol callback(s)
      }
 
 mkMiniProtocolInfo :: MiniProtocol mode initiatorCtx responderCtx bytes m a b -> [MiniProtocolInfo mode]