From aa7bc1013062d2dc8f8384ebcaf2d0074d576bdc Mon Sep 17 00:00:00 2001
From: Karl Knutsson <karl.fb.knutsson@gmail.com>
Date: Wed, 29 Jan 2025 11:20:39 +0100
Subject: [PATCH] FIXUP: test haddock

---
 network-mux/test/Test/Mux.hs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/network-mux/test/Test/Mux.hs b/network-mux/test/Test/Mux.hs
index d3d9310fe6..14da04f5b1 100644
--- a/network-mux/test/Test/Mux.hs
+++ b/network-mux/test/Test/Mux.hs
@@ -1601,6 +1601,7 @@ prop_mux_restart_m (DummyRestartingInitiatorResponderApps rapps) = do
 
 
 
+-- | Verifying starting and stopping of miniprotocols. Both normal exits and by exception.
 prop_mux_start_m :: forall m.
                        ( Alternative (STM m)
                        , MonadAsync m
@@ -1613,14 +1614,23 @@ prop_mux_start_m :: forall m.
                        , MonadTimer m
                        )
                     => Mx.Bearer m
+                    -- ^ Mux bearer
                     -> (DummyApp -> m ())
+                    -- ^ trigger action that starts the app
                     -> (    DiffTime
+                         -- ^ How long did the test run.
                          -> ((STM m (Either SomeException ())), DummyApp)
+                         -- ^ Result for running the app, along with the app
                          -> m (Property, Either SomeException ())
                        )
+                    -- ^ Verify that the app succeded/failed as expected when
+                    -- the test stopped
                     -> DummyApps
+                    -- ^ List of apps to test
                     -> DiffTime
+                    -- ^ Maximum run time
                     -> DiffTime
+                    -- ^ Time at which StartOnDemandAny should run
                     -> m Property
 prop_mux_start_m bearer _ checkRes (DummyInitiatorApps apps) runTime _ = do
     let minis = map (appToInfo Mx.InitiatorDirectionOnly) apps