CLaSH.NamedTypes

Add inline documentation to types:

fifo
  :: SClock clk
  -> SNat addrSize
  -> "read request" ::: Signal' clk Bool
  -> "write request" ::: Signal' clk (Maybe (BitVector dataSize))
  -> ( "q"     ::: Signal' clk (BitVector dataSize)
     , "full"  ::: Signal' clk Bool
     , "empty" ::: Signal' clk Bool
     )

which can subsequently be inspected in the interactive environment:

>>> :t fifo systemClock
fifo systemClock
  :: SNat addrSize
     -> "read request" ::: Signal' SystemClock Bool
     -> "write request"
        ::: Signal' SystemClock (Maybe (BitVector dataSize))
     -> ("q" ::: Signal' SystemClock (BitVector dataSize),
         "full" ::: Signal' SystemClock Bool,
         "empty" ::: Signal' SystemClock Bool)

Documentation

type (:::) name a = a

Annotate a type with a name