From 5d314ee9dcea872495cddbfeba5465d184ab3544 Mon Sep 17 00:00:00 2001
From: Marcin Szamotulski <coot@coot.me>
Date: Mon, 10 Feb 2025 07:00:06 +0100
Subject: [PATCH] framework: added haddocks to MiniProtocol type

---
 ouroboros-network-framework/src/Ouroboros/Network/Mux.hs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/ouroboros-network-framework/src/Ouroboros/Network/Mux.hs b/ouroboros-network-framework/src/Ouroboros/Network/Mux.hs
index 17f11ed7cce..668d4a94f23 100644
--- 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]