typed-protocols-doc-0.1.0.0: Derive documentation from typed-protocols source code

Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.TypedProtocol.Documentation.Text

Documentation

type Build = RWS Int Builder Bool () Source #

runBuild :: Build -> Text Source #

indent :: Build Source #

assertLineStart :: Build Source #

withIndent :: Int -> Build -> Build Source #

write :: Builder -> Build Source #

string :: String -> Build Source #

newline :: Build Source #

buildBare :: Build -> Text Source #

p :: Build -> Build Source #

stringLine :: String -> Build Source #

h :: Int -> String -> Build Source #

ul :: [Build] -> Build Source #

ol :: [(Int, Build)] -> Build Source #

link :: String -> Build -> Build Source #

renderDescriptions :: [Description] -> Build Source #

renderHaddock :: DocH mod String -> Build Source #

data TOC a Source #

Constructors

TOC a [TOC a]

Instances

Instances details

Show a => Show (TOC a) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Text Methods showsPrec :: Int -> TOC a -> ShowS # show :: TOC a -> String # showList :: [TOC a] -> ShowS #
Eq a => Eq (TOC a) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Text Methods (==) :: TOC a -> TOC a -> Bool # (/=) :: TOC a -> TOC a -> Bool #
Ord a => Ord (TOC a) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Text Methods compare :: TOC a -> TOC a -> Ordering # (<) :: TOC a -> TOC a -> Bool # (<=) :: TOC a -> TOC a -> Bool # (>) :: TOC a -> TOC a -> Bool # (>=) :: TOC a -> TOC a -> Bool # max :: TOC a -> TOC a -> TOC a # min :: TOC a -> TOC a -> TOC a #

renderTOC :: TOC (String, String) -> Build Source #

stateID :: String -> String -> String Source #

stateTOC :: String -> String -> TOC (String, String) Source #

renderMessageRef :: String -> MessageDescription codec -> Build Source #

renderState :: [MessageDescription codec] -> (StateRef, [Description], AgencyID) -> Build Source #

formatStateRef :: StateRef -> Build Source #

messageID :: String -> String -> String Source #

messageTOC :: String -> MessageDescription codec -> TOC (String, String) Source #

formatFieldSize :: FieldSize -> String Source #

renderMessage :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => MessageDescription codec -> Build Source #

protocolTOC :: ProtocolDescription codec -> TOC (String, String) Source #

renderProtocol :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => ProtocolDescription codec -> Build Source #

renderFieldSpec :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Build Source #

fieldSpecAnnotations :: FieldInfo codec -> [String] Source #

renderSubfields :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Build Source #

renderFieldType :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Build Source #

renderSubfield :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => SubfieldInfo codec -> Build Source #

renderProtocolDescriptions :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => [ProtocolDescription codec] -> Text Source #