Re-export internal TH functions

- `unitsTupleInstances` - `taggedBundleTupleInstances` - `protocolTupleInstances`
clash-lang · Sep 30, 2024 · 3a9c62f · 3a9c62f
1 parent 5553ae2
commit 3a9c62f
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git 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 <https://github.com/cchalmers/circuit-notation>.
 -}
 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
@@ -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
@@ -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