Safe Haskell | None |
---|---|
Language | Haskell2010 |
Lorentz.UStore.Doc
Contents
Description
Autodoc for UStore.
Synopsis
- class Typeable template => UStoreTemplateHasDoc template where
- class KnownUStoreMarker marker => UStoreMarkerHasDoc (marker :: UStoreMarkerType) where
- ustoreMarkerKeyEncoding :: Text -> Text
- data DUStoreTemplate where
- DUStoreTemplate :: UStoreTemplateHasDoc template => Proxy template -> DUStoreTemplate
- dUStoreTemplateRef :: DUStoreTemplate -> Markdown
- data DocumentTW
Documentation
class Typeable template => UStoreTemplateHasDoc template where Source #
Information for UStore template required for documentation.
You only need to instantiate this for templates used directly in UStore, nested subtemplates do not need this instance.
Minimal complete definition
Methods
ustoreTemplateDocName :: Text Source #
UStore template name as it appears in documentation.
Should be only 1 word.
default ustoreTemplateDocName :: (Generic template, KnownSymbol (GenericTypeName template)) => Text Source #
ustoreTemplateDocDescription :: Markdown Source #
Description of template.
ustoreTemplateDocContents :: Markdown Source #
Description of template entries.
default ustoreTemplateDocContents :: UStoreTraversable DocumentTW template => Markdown Source #
ustoreTemplateDocDependencies :: [SomeTypeWithDoc] Source #
default ustoreTemplateDocDependencies :: UStoreTraversable DocumentTW template => [SomeTypeWithDoc] Source #
Instances
class KnownUStoreMarker marker => UStoreMarkerHasDoc (marker :: UStoreMarkerType) where Source #
Instantiated for documented UStore markers.
Methods
ustoreMarkerKeyEncoding :: Text -> Text Source #
Specifies key encoding.
You accept description of field name, and should return how is it encoded
as key of big_map bytes bytes
.
Instances
UStoreMarkerHasDoc UMarkerPlainField Source # | |
Defined in Lorentz.UStore.Doc Methods ustoreMarkerKeyEncoding :: Text -> Text Source # |
data DUStoreTemplate where Source #
Constructors
DUStoreTemplate :: UStoreTemplateHasDoc template => Proxy template -> DUStoreTemplate |
Instances
dUStoreTemplateRef :: DUStoreTemplate -> Markdown Source #
Make a reference to given UStore template description.
data DocumentTW Source #
Instances
Orphan instances
UStoreTemplateHasDoc template => TypeHasDoc (UStore template) Source # | |
Associated Types type TypeDocFieldDescriptions (UStore template) :: FieldDescriptions # Methods typeDocName :: Proxy (UStore template) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (UStore template) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (UStore template) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (UStore template) # typeDocMichelsonRep :: TypeDocMichelsonRep (UStore template) # |