lorentz-0.6.1: EDSL for the Michelson Language
Safe HaskellNone
LanguageHaskell2010

Lorentz.UStore.Doc

Description

Autodoc for UStore.

Synopsis

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

ustoreTemplateDocDescription

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

Instances details
UStoreTemplateHasDoc () Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

ustoreTemplateDocName :: Text Source #

ustoreTemplateDocDescription :: Markdown Source #

ustoreTemplateDocContents :: Markdown Source #

ustoreTemplateDocDependencies :: [SomeTypeWithDoc] Source #

UStoreTemplateHasDoc SomeUTemplate Source # 
Instance details

Defined in Lorentz.UStore.Migration.Base

Methods

ustoreTemplateDocName :: Text Source #

ustoreTemplateDocDescription :: Markdown Source #

ustoreTemplateDocContents :: Markdown Source #

ustoreTemplateDocDependencies :: [SomeTypeWithDoc] Source #

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

Instances details
UStoreMarkerHasDoc UMarkerPlainField Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

ustoreMarkerKeyEncoding :: Text -> Text Source #

data DUStoreTemplate where Source #

Constructors

DUStoreTemplate :: UStoreTemplateHasDoc template => Proxy template -> DUStoreTemplate 

Instances

Instances details
Eq DUStoreTemplate Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

(==) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

(/=) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

Ord DUStoreTemplate Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

compare :: DUStoreTemplate -> DUStoreTemplate -> Ordering #

(<) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

(<=) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

(>) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

(>=) :: DUStoreTemplate -> DUStoreTemplate -> Bool #

max :: DUStoreTemplate -> DUStoreTemplate -> DUStoreTemplate #

min :: DUStoreTemplate -> DUStoreTemplate -> DUStoreTemplate #

DocItem DUStoreTemplate Source # 
Instance details

Defined in Lorentz.UStore.Doc

Associated Types

type DocItemPlacement DUStoreTemplate :: DocItemPlacementKind #

type DocItemReferenced DUStoreTemplate :: DocItemReferencedKind #

Methods

docItemPos :: Natural #

docItemSectionName :: Maybe Text #

docItemSectionDescription :: Maybe Markdown #

docItemSectionNameStyle :: DocSectionNameStyle #

docItemRef :: DUStoreTemplate -> DocItemRef (DocItemPlacement DUStoreTemplate) (DocItemReferenced DUStoreTemplate) #

docItemToMarkdown :: HeaderLevel -> DUStoreTemplate -> Markdown #

docItemToToc :: HeaderLevel -> DUStoreTemplate -> Markdown #

docItemDependencies :: DUStoreTemplate -> [SomeDocDefinitionItem] #

docItemsOrder :: [DUStoreTemplate] -> [DUStoreTemplate] #

type DocItemPlacement DUStoreTemplate Source # 
Instance details

Defined in Lorentz.UStore.Doc

type DocItemPlacement DUStoreTemplate = 'DocItemInDefinitions
type DocItemReferenced DUStoreTemplate Source # 
Instance details

Defined in Lorentz.UStore.Doc

type DocItemReferenced DUStoreTemplate = 'True

dUStoreTemplateRef :: DUStoreTemplate -> Markdown Source #

Make a reference to given UStore template description.

data DocumentTW Source #

Instances

Instances details
UStoreTraversalWay DocumentTW Source # 
Instance details

Defined in Lorentz.UStore.Doc

Associated Types

type UStoreTraversalArgumentWrapper DocumentTW :: Type -> Type Source #

type UStoreTraversalMonad DocumentTW :: Type -> Type Source #

(TypeHasDoc k, TypeHasDoc v) => UStoreTraversalSubmapHandler DocumentTW k v Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

ustoreTraversalSubmapHandler :: forall (name :: Symbol). DocumentTW -> Label name -> UStoreTraversalArgumentWrapper DocumentTW (Map k v) -> UStoreTraversalMonad DocumentTW (Map k v) Source #

(UStoreMarkerHasDoc marker, TypeHasDoc v) => UStoreTraversalFieldHandler DocumentTW marker v Source # 
Instance details

Defined in Lorentz.UStore.Doc

Methods

ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => DocumentTW -> Label name -> UStoreTraversalArgumentWrapper DocumentTW v -> UStoreTraversalMonad DocumentTW v Source #

type UStoreTraversalArgumentWrapper DocumentTW Source # 
Instance details

Defined in Lorentz.UStore.Doc

type UStoreTraversalArgumentWrapper DocumentTW = Const () :: Type -> Type
type UStoreTraversalMonad DocumentTW Source # 
Instance details

Defined in Lorentz.UStore.Doc

type UStoreTraversalMonad DocumentTW

Orphan instances

UStoreTemplateHasDoc template => TypeHasDoc (UStore template) Source # 
Instance details

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) #