From f0821748f4d6b49b5c20d4dfb9389208cceee3c5 Mon Sep 17 00:00:00 2001
From: Lucas Bollen <lucas@qbaylogic.com>
Date: Mon, 30 Sep 2024 10:51:24 +0200
Subject: [PATCH] Small haddock improvements

---
 clash-protocols-base/src/Protocols/Plugin/TH.hs    | 1 +
 clash-protocols-base/src/Protocols/Plugin/Types.hs | 1 +
 clash-protocols/src/Protocols/Internal.hs          | 4 ++--
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/clash-protocols-base/src/Protocols/Plugin/TH.hs b/clash-protocols-base/src/Protocols/Plugin/TH.hs
index dcd202e9..a53d2fa8 100644
--- a/clash-protocols-base/src/Protocols/Plugin/TH.hs
+++ b/clash-protocols-base/src/Protocols/Plugin/TH.hs
@@ -7,6 +7,7 @@ import Language.Haskell.TH
 appTs :: Q Type -> [Q Type] -> Q Type
 appTs = foldl appT
 
+-- | Generate @Protocol@ instances for n-tuples
 protocolTupleInstances :: Int -> Int -> Q [Dec]
 protocolTupleInstances n m = mapM protocolTupleInstance [n .. m]
 
diff --git a/clash-protocols-base/src/Protocols/Plugin/Types.hs b/clash-protocols-base/src/Protocols/Plugin/Types.hs
index 5463defe..f317d603 100644
--- a/clash-protocols-base/src/Protocols/Plugin/Types.hs
+++ b/clash-protocols-base/src/Protocols/Plugin/Types.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE RoleAnnotations #-}
 
+{-# OPTIONS_HADDOCK hide #-}
 {- |
 These class definitions are needed to be able to write Template Haskell quotes
 for instances. They are defined separately to avoid import loops.
diff --git a/clash-protocols/src/Protocols/Internal.hs b/clash-protocols/src/Protocols/Internal.hs
index bb592f5a..4d59dada 100644
--- a/clash-protocols/src/Protocols/Internal.hs
+++ b/clash-protocols/src/Protocols/Internal.hs
@@ -299,9 +299,9 @@ class (C.KnownNat (SimulateChannels a), Backpressure a, Simulate a) => Drivable
 kind of simulation requires a lists for both the forward and the backward direction.
 
 This class requires the definition of the types that the test supplies and returns. Its
-functions are converters from these /simulation types/ to types on the 'Signal' level.
+functions are converters from these /simulation types/ to types on the 'Clash.Signal.Signal' level.
 The 'simulateCircuit' function can thus receive the necessary simulation types, convert
-them to types on the 'Signal' level, pass those signals to the circuit, and convert the
+them to types on the 'Clash.Signal.Signal' level, pass those signals to the circuit, and convert the
 result of the circuit back to the simulation types giving the final result.
 -}
 class (C.KnownNat (SimulateChannels a), Protocol a) => Simulate a where