Skip to content

Commit eb91e43

Browse files
committed
Add missing documentation
1 parent a2a57a7 commit eb91e43

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

src/Protocols/Axi4/ReadAddress.hs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,9 @@ deriving instance
187187
, C.NFDataX (QosType kq) ) =>
188188
C.NFDataX (M2S_ReadAddress kb ksz lw iw aw kr kbl kl kc kp kq userType)
189189

190-
190+
-- | Circuit that transforms the LHS 'Axi4ReadAddress' protocol to a
191+
-- version using different type parameters according to two functions
192+
-- that can transform the data and ack signal to and from the other protocol.
191193
mapFull ::
192194
forall dom
193195
kb1 ksz1 lw1 iw1 aw1 kr1 kbl1 kl1 kc1 kp1 kq1 t1

src/Protocols/Axi4/WriteAddress.hs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,9 @@ deriving instance
185185
, C.NFDataX (QosType kq) ) =>
186186
C.NFDataX (M2S_WriteAddress kb ksz lw iw aw kr kbl kl kc kp kq userType)
187187

188+
-- | Circuit that transforms the LHS 'Axi4WriteAddress' protocol to a
189+
-- version using different type parameters according to two functions
190+
-- that can transform the data and ack signal to and from the other protocol.
188191
mapFull ::
189192
forall dom
190193
kb1 ksz1 lw1 iw1 aw1 kr1 kbl1 kl1 kc1 kp1 kq1 userType1

src/Protocols/Axi4/WriteData.hs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,9 @@ deriving instance
131131
, C.KnownNat nBytes ) =>
132132
Show (M2S_WriteData ks nBytes userType)
133133

134+
-- | Circuit that transforms the LHS 'Axi4WriteData' protocol to a
135+
-- version using different type parameters according to two functions
136+
-- that can transform the data and ack signal to and from the other protocol.
134137
mapFull ::
135138
forall dom ks1 ks2 nBytes1 nBytes2 t1 t2.
136139
(M2S_WriteData ks1 nBytes1 t1 -> M2S_WriteData ks2 nBytes2 t2) ->

src/Protocols/Axi4/WriteResponse.hs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ deriving instance
126126
, C.KnownNat (Width iw) ) =>
127127
Show (S2M_WriteResponse kr iw userType)
128128

129+
-- | Circuit that transforms the LHS 'Axi4WriteResponse' protocol to a
130+
-- version using different type parameters according to two functions
131+
-- that can transform the data and ack signal to and from the other protocol.
129132
mapFull ::
130133
forall dom
131134
kr1 iw1 userType1

0 commit comments

Comments
 (0)