typed-protocols-doc

Safe Haskell	None
Language	Haskell2010

Network.TypedProtocol.Documentation.Html

Documentation

renderDescriptions :: [Description] -> Html Source #

renderHaddock :: DocH mod String -> Html 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.Html 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.Html Methods (==) :: TOC a -> TOC a -> Bool # (/=) :: TOC a -> TOC a -> Bool #
Ord a => Ord (TOC a) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Html 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) -> Html Source #

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

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

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

formatStateRef :: String -> StateRef -> Html 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)) => String -> MessageDescription codec -> Html Source #

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

protocolToSvgMem :: ProtocolDescription codec -> ByteString Source #

renderDiagramSvg :: ProtocolDescription codec -> Html Source #

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

fieldSpecToHTML :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Html Source #

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

subfieldsToHTML :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Maybe Html Source #

fieldTypeToHtml :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> Html Source #

subfieldToHtmlTR :: (HasInfo codec Word32, HasInfo codec (DefEnumEncoding codec)) => SubfieldInfo codec -> Html Source #

wrapDocument :: Html -> Html Source #

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