diff --git a/clash-protocols-base/src/Protocols/Plugin.hs b/clash-protocols-base/src/Protocols/Plugin.hs index c458217b..2df0e080 100644 --- a/clash-protocols-base/src/Protocols/Plugin.hs +++ b/clash-protocols-base/src/Protocols/Plugin.hs @@ -7,12 +7,20 @@ A GHC source plugin providing a DSL for writing Circuit components. Credits to @circuit-notation@ at . -} module Protocols.Plugin ( + -- * Circuit types Circuit (..), Protocol (..), + + -- * clash-prelude related types CSignal, + + -- * plugin functions plugin, circuit, (-<), + + -- * template haskell functions + protocolTupleInstances, ) where -- base diff --git a/clash-protocols-base/src/Protocols/Plugin/TaggedBundle.hs b/clash-protocols-base/src/Protocols/Plugin/TaggedBundle.hs index 78db9f0e..7e2f723c 100644 --- a/clash-protocols-base/src/Protocols/Plugin/TaggedBundle.hs +++ b/clash-protocols-base/src/Protocols/Plugin/TaggedBundle.hs @@ -6,7 +6,14 @@ -- For debugging TH: -- {-# OPTIONS_GHC -ddump-splices #-} -module Protocols.Plugin.TaggedBundle where +module Protocols.Plugin.TaggedBundle ( + -- * Typeclasses + TaggedBundle (..), + pattern TaggedBundle, + + -- * Template haskell functions + taggedBundleTupleInstances, +) where import Clash.Explicit.Prelude diff --git a/clash-protocols-base/src/Protocols/Plugin/Units.hs b/clash-protocols-base/src/Protocols/Plugin/Units.hs index 9da0ab58..9c6d6707 100644 --- a/clash-protocols-base/src/Protocols/Plugin/Units.hs +++ b/clash-protocols-base/src/Protocols/Plugin/Units.hs @@ -5,7 +5,14 @@ -- For debugging TH: -- {-# OPTIONS_GHC -ddump-splices #-} -module Protocols.Plugin.Units where +module Protocols.Plugin.Units ( + -- * Typeclasses + Units (..), + + -- * Template haskell functions + unitsTupleInstances, +) +where import Clash.Explicit.Prelude