Safe Haskell | None |
---|---|
Language | Haskell98 |
- data DocsContext = DocsContext {}
- writeDocs :: DocsContext -> Router m s -> String -> IO ()
- writeSingleResource :: DocsContext -> String -> ApiResource -> IO ()
- mkAllResources :: DocsContext -> ApiResource -> IO String
- mkSingleResource :: DocsContext -> ApiResource -> IO String
- cls :: String -> Attribute
- cdiv :: String -> Html -> Html
- row :: Html -> Html
- resourcesInfo :: DocsContext -> ApiResource -> Html
- subResourcesInfo :: DocsContext -> ApiResource -> Html
- resourceInfo :: DocsContext -> ApiResource -> Html
- resourceIdentifiers :: Link -> [Link] -> [Html]
- resourceTable :: ApiResource -> Html
- dataDescriptions :: String -> [DataDescription] -> Html
- mkCode :: String -> String -> String -> Html
- resourceId :: ResourceId -> String
- resourceDisp :: ResourceId -> Html
- resourceLinkAnchor :: ResourceId -> Html -> Html
- resourceLinkRemote :: String -> ResourceId -> Html -> Html
- resourceAnchor :: ResourceId -> Html
- linkHtml :: Link -> Html
Documentation
writeSingleResource :: DocsContext -> String -> ApiResource -> IO () Source
mkAllResources :: DocsContext -> ApiResource -> IO String Source
mkSingleResource :: DocsContext -> ApiResource -> IO String Source
resourcesInfo :: DocsContext -> ApiResource -> Html Source
Recursively generate information for a resource structure
subResourcesInfo :: DocsContext -> ApiResource -> Html Source
resourceInfo :: DocsContext -> ApiResource -> Html Source
Generate information for one resource
resourceIdentifiers :: Link -> [Link] -> [Html] Source
resourceTable :: ApiResource -> Html Source
dataDescriptions :: String -> [DataDescription] -> Html Source
Generate information for input/output data structure
mkCode :: String -> String -> String -> Html Source
Helper function for setting the right attributes to make something collapsible. The javascript prt can be found in docs.js
resourceId :: ResourceId -> String Source
resourceDisp :: ResourceId -> Html Source
resourceLinkAnchor :: ResourceId -> Html -> Html Source
resourceLinkRemote :: String -> ResourceId -> Html -> Html Source
resourceAnchor :: ResourceId -> Html Source