Skip to content

Commit f082174

Browse files
committed
Small haddock improvements
1 parent e5a047a commit f082174

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

clash-protocols-base/src/Protocols/Plugin/TH.hs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import Language.Haskell.TH
77
appTs :: Q Type -> [Q Type] -> Q Type
88
appTs = foldl appT
99

10+
-- | Generate @Protocol@ instances for n-tuples
1011
protocolTupleInstances :: Int -> Int -> Q [Dec]
1112
protocolTupleInstances n m = mapM protocolTupleInstance [n .. m]
1213

clash-protocols-base/src/Protocols/Plugin/Types.hs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{-# LANGUAGE RoleAnnotations #-}
22

3+
{-# OPTIONS_HADDOCK hide #-}
34
{- |
45
These class definitions are needed to be able to write Template Haskell quotes
56
for instances. They are defined separately to avoid import loops.

clash-protocols/src/Protocols/Internal.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,9 +299,9 @@ class (C.KnownNat (SimulateChannels a), Backpressure a, Simulate a) => Drivable
299299
kind of simulation requires a lists for both the forward and the backward direction.
300300
301301
This class requires the definition of the types that the test supplies and returns. Its
302-
functions are converters from these /simulation types/ to types on the 'Signal' level.
302+
functions are converters from these /simulation types/ to types on the 'Clash.Signal.Signal' level.
303303
The 'simulateCircuit' function can thus receive the necessary simulation types, convert
304-
them to types on the 'Signal' level, pass those signals to the circuit, and convert the
304+
them to types on the 'Clash.Signal.Signal' level, pass those signals to the circuit, and convert the
305305
result of the circuit back to the simulation types giving the final result.
306306
-}
307307
class (C.KnownNat (SimulateChannels a), Protocol a) => Simulate a where

0 commit comments

Comments
 (0)