Takes an instruction that inserts documentation items with general information about the contract. Inserts it into general section. See DGeneralInfoSection.

contractGeneralDefault :: s :-> s Source #

Inserts general information about the contract using the default format.

Currently we only include git revision. It is unknown in the library code and is supposed to be updated in an executable.

cutLorentzNonDoc :: (inp :-> out) -> s :-> s Source #

Leave only instructions related to documentation.

This function is useful when your method executes a lambda coming from outside, but you know its properties and want to propagate its documentation to your contract code.

Re-exports

type Markdown = Builder #

data DocElem d #

Constructors

DocElem
Fields deItem :: d deSub :: Maybe SubDoc

class (Typeable d, DOrd d) => DocItem d where #

Minimal complete definition

docItemPos, docItemSectionName, docItemToMarkdown

Associated Types

type DocItemPlacement d :: DocItemPlacementKind #

type DocItemPlacement d = 'DocItemInlined #

type DocItemReferenced d :: DocItemReferencedKind #

type DocItemReferenced d = 'False #

Methods

docItemPos :: Natural #

docItemSectionName :: Maybe Text #

docItemSectionDescription :: Maybe Markdown #

docItemSectionNameStyle :: DocSectionNameStyle #

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

docItemToMarkdown :: HeaderLevel -> d -> Markdown #

docItemToToc :: HeaderLevel -> d -> Markdown #

docItemDependencies :: d -> [SomeDocDefinitionItem] #

docItemsOrder :: [d] -> [d] #

Instances

Instances details

DocItem DStorageType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPlacement DStorageType :: DocItemPlacementKind # type DocItemReferenced DStorageType :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DStorageType -> DocItemRef (DocItemPlacement DStorageType) (DocItemReferenced DStorageType) # docItemToMarkdown :: HeaderLevel -> DStorageType -> Markdown # docItemToToc :: HeaderLevel -> DStorageType -> Markdown # docItemDependencies :: DStorageType -> [SomeDocDefinitionItem] # docItemsOrder :: [DStorageType] -> [DStorageType] #
DocItem DType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPlacement DType :: DocItemPlacementKind # type DocItemReferenced DType :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DType -> DocItemRef (DocItemPlacement DType) (DocItemReferenced DType) # docItemToMarkdown :: HeaderLevel -> DType -> Markdown # docItemToToc :: HeaderLevel -> DType -> Markdown # docItemDependencies :: DType -> [SomeDocDefinitionItem] # docItemsOrder :: [DType] -> [DType] #
DocItem DAnchor
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DAnchor :: DocItemPlacementKind # type DocItemReferenced DAnchor :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DAnchor -> DocItemRef (DocItemPlacement DAnchor) (DocItemReferenced DAnchor) # docItemToMarkdown :: HeaderLevel -> DAnchor -> Markdown # docItemToToc :: HeaderLevel -> DAnchor -> Markdown # docItemDependencies :: DAnchor -> [SomeDocDefinitionItem] # docItemsOrder :: [DAnchor] -> [DAnchor] #
DocItem DComment
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DComment :: DocItemPlacementKind # type DocItemReferenced DComment :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DComment -> DocItemRef (DocItemPlacement DComment) (DocItemReferenced DComment) # docItemToMarkdown :: HeaderLevel -> DComment -> Markdown # docItemToToc :: HeaderLevel -> DComment -> Markdown # docItemDependencies :: DComment -> [SomeDocDefinitionItem] # docItemsOrder :: [DComment] -> [DComment] #
DocItem DDescription
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DDescription :: DocItemPlacementKind # type DocItemReferenced DDescription :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescription -> DocItemRef (DocItemPlacement DDescription) (DocItemReferenced DDescription) # docItemToMarkdown :: HeaderLevel -> DDescription -> Markdown # docItemToToc :: HeaderLevel -> DDescription -> Markdown # docItemDependencies :: DDescription -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescription] -> [DDescription] #
DocItem DGeneralInfoSection
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DGeneralInfoSection :: DocItemPlacementKind # type DocItemReferenced DGeneralInfoSection :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGeneralInfoSection -> DocItemRef (DocItemPlacement DGeneralInfoSection) (DocItemReferenced DGeneralInfoSection) # docItemToMarkdown :: HeaderLevel -> DGeneralInfoSection -> Markdown # docItemToToc :: HeaderLevel -> DGeneralInfoSection -> Markdown # docItemDependencies :: DGeneralInfoSection -> [SomeDocDefinitionItem] # docItemsOrder :: [DGeneralInfoSection] -> [DGeneralInfoSection] #
DocItem DGitRevision
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DGitRevision :: DocItemPlacementKind # type DocItemReferenced DGitRevision :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGitRevision -> DocItemRef (DocItemPlacement DGitRevision) (DocItemReferenced DGitRevision) # docItemToMarkdown :: HeaderLevel -> DGitRevision -> Markdown # docItemToToc :: HeaderLevel -> DGitRevision -> Markdown # docItemDependencies :: DGitRevision -> [SomeDocDefinitionItem] # docItemsOrder :: [DGitRevision] -> [DGitRevision] #
DocItem DName
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DName :: DocItemPlacementKind # type DocItemReferenced DName :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DName -> DocItemRef (DocItemPlacement DName) (DocItemReferenced DName) # docItemToMarkdown :: HeaderLevel -> DName -> Markdown # docItemToToc :: HeaderLevel -> DName -> Markdown # docItemDependencies :: DName -> [SomeDocDefinitionItem] # docItemsOrder :: [DName] -> [DName] #
DocItem DToc
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DToc :: DocItemPlacementKind # type DocItemReferenced DToc :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DToc -> DocItemRef (DocItemPlacement DToc) (DocItemReferenced DToc) # docItemToMarkdown :: HeaderLevel -> DToc -> Markdown # docItemToToc :: HeaderLevel -> DToc -> Markdown # docItemDependencies :: DToc -> [SomeDocDefinitionItem] # docItemsOrder :: [DToc] -> [DToc] #
DocItem DEntrypointExample Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DEntrypointExample :: DocItemPlacementKind # type DocItemReferenced DEntrypointExample :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypointExample -> DocItemRef (DocItemPlacement DEntrypointExample) (DocItemReferenced DEntrypointExample) # docItemToMarkdown :: HeaderLevel -> DEntrypointExample -> Markdown # docItemToToc :: HeaderLevel -> DEntrypointExample -> Markdown # docItemDependencies :: DEntrypointExample -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypointExample] -> [DEntrypointExample] #
DocItem DThrows Source #
Instance details Defined in Lorentz.Errors Associated Types type DocItemPlacement DThrows :: DocItemPlacementKind # type DocItemReferenced DThrows :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DThrows -> DocItemRef (DocItemPlacement DThrows) (DocItemReferenced DThrows) # docItemToMarkdown :: HeaderLevel -> DThrows -> Markdown # docItemToToc :: HeaderLevel -> DThrows -> Markdown # docItemDependencies :: DThrows -> [SomeDocDefinitionItem] # docItemsOrder :: [DThrows] -> [DThrows] #
DocItem DError Source #
Instance details Defined in Lorentz.Errors Associated Types type DocItemPlacement DError :: DocItemPlacementKind # type DocItemReferenced DError :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DError -> DocItemRef (DocItemPlacement DError) (DocItemReferenced DError) # docItemToMarkdown :: HeaderLevel -> DError -> Markdown # docItemToToc :: HeaderLevel -> DError -> Markdown # docItemDependencies :: DError -> [SomeDocDefinitionItem] # docItemsOrder :: [DError] -> [DError] #
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] #
DocItem DMigrationActionDesc Source #
Instance details Defined in Lorentz.UStore.Migration.Base Associated Types type DocItemPlacement DMigrationActionDesc :: DocItemPlacementKind # type DocItemReferenced DMigrationActionDesc :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DMigrationActionDesc -> DocItemRef (DocItemPlacement DMigrationActionDesc) (DocItemReferenced DMigrationActionDesc) # docItemToMarkdown :: HeaderLevel -> DMigrationActionDesc -> Markdown # docItemToToc :: HeaderLevel -> DMigrationActionDesc -> Markdown # docItemDependencies :: DMigrationActionDesc -> [SomeDocDefinitionItem] # docItemsOrder :: [DMigrationActionDesc] -> [DMigrationActionDesc] #
DocItem DDescribeErrorTagMap Source #
Instance details Defined in Lorentz.Errors.Numeric.Doc Associated Types type DocItemPlacement DDescribeErrorTagMap :: DocItemPlacementKind # type DocItemReferenced DDescribeErrorTagMap :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescribeErrorTagMap -> DocItemRef (DocItemPlacement DDescribeErrorTagMap) (DocItemReferenced DDescribeErrorTagMap) # docItemToMarkdown :: HeaderLevel -> DDescribeErrorTagMap -> Markdown # docItemToToc :: HeaderLevel -> DDescribeErrorTagMap -> Markdown # docItemDependencies :: DDescribeErrorTagMap -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescribeErrorTagMap] -> [DDescribeErrorTagMap] #
DocItem DEntrypointArg Source #
Instance details Defined in Lorentz.Entrypoints.Doc Associated Types type DocItemPlacement DEntrypointArg :: DocItemPlacementKind # type DocItemReferenced DEntrypointArg :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypointArg -> DocItemRef (DocItemPlacement DEntrypointArg) (DocItemReferenced DEntrypointArg) # docItemToMarkdown :: HeaderLevel -> DEntrypointArg -> Markdown # docItemToToc :: HeaderLevel -> DEntrypointArg -> Markdown # docItemDependencies :: DEntrypointArg -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypointArg] -> [DEntrypointArg] #
DocItem DEntrypointReference Source #
Instance details Defined in Lorentz.Entrypoints.Doc Associated Types type DocItemPlacement DEntrypointReference :: DocItemPlacementKind # type DocItemReferenced DEntrypointReference :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypointReference -> DocItemRef (DocItemPlacement DEntrypointReference) (DocItemReferenced DEntrypointReference) # docItemToMarkdown :: HeaderLevel -> DEntrypointReference -> Markdown # docItemToToc :: HeaderLevel -> DEntrypointReference -> Markdown # docItemDependencies :: DEntrypointReference -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypointReference] -> [DEntrypointReference] #
DocItem (DEntrypoint PlainEntrypointsKind) Source #
Instance details Defined in Lorentz.Entrypoints.Doc Associated Types type DocItemPlacement (DEntrypoint PlainEntrypointsKind) :: DocItemPlacementKind # type DocItemReferenced (DEntrypoint PlainEntrypointsKind) :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypoint PlainEntrypointsKind -> DocItemRef (DocItemPlacement (DEntrypoint PlainEntrypointsKind)) (DocItemReferenced (DEntrypoint PlainEntrypointsKind)) # docItemToMarkdown :: HeaderLevel -> DEntrypoint PlainEntrypointsKind -> Markdown # docItemToToc :: HeaderLevel -> DEntrypoint PlainEntrypointsKind -> Markdown # docItemDependencies :: DEntrypoint PlainEntrypointsKind -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypoint PlainEntrypointsKind] -> [DEntrypoint PlainEntrypointsKind] #

docItemPosition :: DocItem d => DocItemPos #

newtype DocItemId #

Constructors

DocItemId Text

Instances

Instances details

Eq DocItemId
Instance details Defined in Michelson.Doc Methods (==) :: DocItemId -> DocItemId -> Bool # (/=) :: DocItemId -> DocItemId -> Bool #
Ord DocItemId
Instance details Defined in Michelson.Doc Methods compare :: DocItemId -> DocItemId -> Ordering # (<) :: DocItemId -> DocItemId -> Bool # (<=) :: DocItemId -> DocItemId -> Bool # (>) :: DocItemId -> DocItemId -> Bool # (>=) :: DocItemId -> DocItemId -> Bool # max :: DocItemId -> DocItemId -> DocItemId # min :: DocItemId -> DocItemId -> DocItemId #
Show DocItemId
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocItemId -> ShowS # show :: DocItemId -> String # showList :: [DocItemId] -> ShowS #
ToAnchor DocItemId
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemId -> Anchor

data DocItemPlacementKind #

Constructors

DocItemInlined
DocItemInDefinitions

newtype DocItemPos #

Constructors

DocItemPos (Natural, Text)

Instances

Instances details

Eq DocItemPos
Instance details Defined in Michelson.Doc Methods (==) :: DocItemPos -> DocItemPos -> Bool # (/=) :: DocItemPos -> DocItemPos -> Bool #
Ord DocItemPos
Instance details Defined in Michelson.Doc Methods compare :: DocItemPos -> DocItemPos -> Ordering # (<) :: DocItemPos -> DocItemPos -> Bool # (<=) :: DocItemPos -> DocItemPos -> Bool # (>) :: DocItemPos -> DocItemPos -> Bool # (>=) :: DocItemPos -> DocItemPos -> Bool # max :: DocItemPos -> DocItemPos -> DocItemPos # min :: DocItemPos -> DocItemPos -> DocItemPos #
Show DocItemPos
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocItemPos -> ShowS # show :: DocItemPos -> String # showList :: [DocItemPos] -> ShowS #
Buildable DocItemPos
Instance details Defined in Michelson.Doc Methods build :: DocItemPos -> Builder #

data DocItemRef (p :: DocItemPlacementKind) (r :: DocItemReferencedKind) where #

Constructors

DocItemRef :: DocItemId -> DocItemRef 'DocItemInDefinitions 'True
DocItemRefInlined :: DocItemId -> DocItemRef 'DocItemInlined 'True
DocItemNoRef :: DocItemRef 'DocItemInlined 'False

Instances

Instances details

ToAnchor (DocItemRef d 'True)
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemRef d 'True -> Anchor

data DocSection #

Constructors

DocItem d => DocSection (NonEmpty $ DocElem d)

Instances

Instances details

Show DocSection
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocSection -> ShowS # show :: DocSection -> String # showList :: [DocSection] -> ShowS #

data DocSectionNameStyle #

Constructors

DocSectionNameBig
DocSectionNameSmall

data SomeDocItem where #

Constructors

SomeDocItem :: forall d. DocItem d => d -> SomeDocItem

Instances

Instances details

Show SomeDocItem
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> SomeDocItem -> ShowS # show :: SomeDocItem -> String # showList :: [SomeDocItem] -> ShowS #
Show DocGrouping
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #
NFData SomeDocItem
Instance details Defined in Michelson.Doc Methods rnf :: SomeDocItem -> () #

data SomeDocDefinitionItem where #

Constructors

SomeDocDefinitionItem :: forall d. (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => d -> SomeDocDefinitionItem

Instances

Instances details

Eq SomeDocDefinitionItem
Instance details Defined in Michelson.Doc Methods (==) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (/=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool #
Ord SomeDocDefinitionItem
Instance details Defined in Michelson.Doc Methods compare :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Ordering # (<) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (<=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (>) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (>=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # max :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> SomeDocDefinitionItem # min :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> SomeDocDefinitionItem #

newtype SubDoc #

Constructors

SubDoc DocBlock

Instances

Instances details

Show DocGrouping
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #

type DocGrouping = SubDoc -> SomeDocItem #

data ContractDoc #

Constructors

ContractDoc
Fields cdContents :: DocBlock cdDefinitions :: DocBlock cdDefinitionsSet :: Set SomeDocDefinitionItem cdDefinitionIds :: Set DocItemId

Instances

Instances details

Semigroup ContractDoc
Instance details Defined in Michelson.Doc Methods (<>) :: ContractDoc -> ContractDoc -> ContractDoc # sconcat :: NonEmpty ContractDoc -> ContractDoc # stimes :: Integral b => b -> ContractDoc -> ContractDoc #
Monoid ContractDoc
Instance details Defined in Michelson.Doc Methods mempty :: ContractDoc # mappend :: ContractDoc -> ContractDoc -> ContractDoc # mconcat :: [ContractDoc] -> ContractDoc #

data DDescription #

Constructors

DDescription Markdown

Instances

Instances details

DocItem DDescription
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DDescription :: DocItemPlacementKind # type DocItemReferenced DDescription :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescription -> DocItemRef (DocItemPlacement DDescription) (DocItemReferenced DDescription) # docItemToMarkdown :: HeaderLevel -> DDescription -> Markdown # docItemToToc :: HeaderLevel -> DDescription -> Markdown # docItemDependencies :: DDescription -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescription] -> [DDescription] #
type DocItemPlacement DDescription
Instance details Defined in Michelson.Doc type DocItemPlacement DDescription = 'DocItemInlined
type DocItemReferenced DDescription
Instance details Defined in Michelson.Doc type DocItemReferenced DDescription = 'False

data DEntrypointExample Source #

Modify the example value of an entrypoint

Constructors

forall t.ParameterScope t => DEntrypointExample (Value t)

Instances

Instances details

DocItem DEntrypointExample Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DEntrypointExample :: DocItemPlacementKind # type DocItemReferenced DEntrypointExample :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypointExample -> DocItemRef (DocItemPlacement DEntrypointExample) (DocItemReferenced DEntrypointExample) # docItemToMarkdown :: HeaderLevel -> DEntrypointExample -> Markdown # docItemToToc :: HeaderLevel -> DEntrypointExample -> Markdown # docItemDependencies :: DEntrypointExample -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypointExample] -> [DEntrypointExample] #
type DocItemPlacement DEntrypointExample Source #
Instance details Defined in Lorentz.Doc type DocItemPlacement DEntrypointExample = 'DocItemInlined
type DocItemReferenced DEntrypointExample Source #
Instance details Defined in Lorentz.Doc type DocItemReferenced DEntrypointExample = 'False

mkDEntrypointExample :: forall a. NiceParameter a => a -> DEntrypointExample Source #

data DGitRevision #

Constructors

DGitRevisionKnown DGitRevisionInfo
DGitRevisionUnknown

Instances

Instances details

DocItem DGitRevision
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DGitRevision :: DocItemPlacementKind # type DocItemReferenced DGitRevision :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGitRevision -> DocItemRef (DocItemPlacement DGitRevision) (DocItemReferenced DGitRevision) # docItemToMarkdown :: HeaderLevel -> DGitRevision -> Markdown # docItemToToc :: HeaderLevel -> DGitRevision -> Markdown # docItemDependencies :: DGitRevision -> [SomeDocDefinitionItem] # docItemsOrder :: [DGitRevision] -> [DGitRevision] #
type DocItemPlacement DGitRevision
Instance details Defined in Michelson.Doc type DocItemPlacement DGitRevision = 'DocItemInlined
type DocItemReferenced DGitRevision
Instance details Defined in Michelson.Doc type DocItemReferenced DGitRevision = 'False

newtype GitRepoSettings #

Constructors

GitRepoSettings
Fields grsMkGitRevision :: Text -> Text

mkDGitRevision :: ExpQ #

morleyRepoSettings :: GitRepoSettings #

data DComment #

Constructors

DComment Text

Instances

Instances details

DocItem DComment
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DComment :: DocItemPlacementKind # type DocItemReferenced DComment :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DComment -> DocItemRef (DocItemPlacement DComment) (DocItemReferenced DComment) # docItemToMarkdown :: HeaderLevel -> DComment -> Markdown # docItemToToc :: HeaderLevel -> DComment -> Markdown # docItemDependencies :: DComment -> [SomeDocDefinitionItem] # docItemsOrder :: [DComment] -> [DComment] #
type DocItemPlacement DComment
Instance details Defined in Michelson.Doc type DocItemPlacement DComment = 'DocItemInlined
type DocItemReferenced DComment
Instance details Defined in Michelson.Doc type DocItemReferenced DComment = 'False

data DAnchor #

Constructors

DAnchor Anchor

Instances

Instances details

DocItem DAnchor
Instance details Defined in Michelson.Doc Associated Types type DocItemPlacement DAnchor :: DocItemPlacementKind # type DocItemReferenced DAnchor :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DAnchor -> DocItemRef (DocItemPlacement DAnchor) (DocItemReferenced DAnchor) # docItemToMarkdown :: HeaderLevel -> DAnchor -> Markdown # docItemToToc :: HeaderLevel -> DAnchor -> Markdown # docItemDependencies :: DAnchor -> [SomeDocDefinitionItem] # docItemsOrder :: [DAnchor] -> [DAnchor] #
type DocItemPlacement DAnchor
Instance details Defined in Michelson.Doc type DocItemPlacement DAnchor = 'DocItemInlined
type DocItemReferenced DAnchor
Instance details Defined in Michelson.Doc type DocItemReferenced DAnchor = 'False

data DType where #

Constructors

DType :: forall a. TypeHasDoc a => Proxy a -> DType

Instances

Instances details

Eq DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods (==) :: DType -> DType -> Bool # (/=) :: DType -> DType -> Bool #
Ord DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods compare :: DType -> DType -> Ordering # (<) :: DType -> DType -> Bool # (<=) :: DType -> DType -> Bool # (>) :: DType -> DType -> Bool # (>=) :: DType -> DType -> Bool # max :: DType -> DType -> DType # min :: DType -> DType -> DType #
Show DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods showsPrec :: Int -> DType -> ShowS # show :: DType -> String # showList :: [DType] -> ShowS #
DocItem DType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPlacement DType :: DocItemPlacementKind # type DocItemReferenced DType :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DType -> DocItemRef (DocItemPlacement DType) (DocItemReferenced DType) # docItemToMarkdown :: HeaderLevel -> DType -> Markdown # docItemToToc :: HeaderLevel -> DType -> Markdown # docItemDependencies :: DType -> [SomeDocDefinitionItem] # docItemsOrder :: [DType] -> [DType] #
type DocItemPlacement DType
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemPlacement DType = 'DocItemInDefinitions
type DocItemReferenced DType
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemReferenced DType = 'True

dTypeDep :: TypeHasDoc t => SomeDocDefinitionItem #

docDefinitionRef :: (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => Markdown -> d -> Markdown #

contractDocToMarkdown :: ContractDoc -> LText #

subDocToMarkdown :: HeaderLevel -> SubDoc -> Markdown #

class (Typeable a, SingI (TypeDocFieldDescriptions a), FieldDescriptionsValid (TypeDocFieldDescriptions a) a) => TypeHasDoc a where #

Minimal complete definition

typeDocMdDescription

Associated Types

type TypeDocFieldDescriptions a :: FieldDescriptions #

type TypeDocFieldDescriptions a = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))] #

Methods

typeDocName :: Proxy a -> Text #

typeDocMdDescription :: Markdown #

typeDocMdReference :: Proxy a -> WithinParens -> Markdown #

typeDocDependencies :: Proxy a -> [SomeDocDefinitionItem] #

typeDocHaskellRep :: TypeDocHaskellRep a #

typeDocMichelsonRep :: TypeDocMichelsonRep a #

Instances

Instances details

TypeHasDoc Bool
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Bool :: FieldDescriptions # Methods typeDocName :: Proxy Bool -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Bool -> WithinParens -> Markdown # typeDocDependencies :: Proxy Bool -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Bool # typeDocMichelsonRep :: TypeDocMichelsonRep Bool #
TypeHasDoc Integer
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Integer :: FieldDescriptions # Methods typeDocName :: Proxy Integer -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Integer -> WithinParens -> Markdown # typeDocDependencies :: Proxy Integer -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Integer # typeDocMichelsonRep :: TypeDocMichelsonRep Integer #
TypeHasDoc Natural
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Natural :: FieldDescriptions # Methods typeDocName :: Proxy Natural -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Natural -> WithinParens -> Markdown # typeDocDependencies :: Proxy Natural -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Natural # typeDocMichelsonRep :: TypeDocMichelsonRep Natural #
TypeHasDoc ()
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions () :: FieldDescriptions # Methods typeDocName :: Proxy () -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy () -> WithinParens -> Markdown # typeDocDependencies :: Proxy () -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep () # typeDocMichelsonRep :: TypeDocMichelsonRep () #
TypeHasDoc ByteString
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions ByteString :: FieldDescriptions # Methods typeDocName :: Proxy ByteString -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy ByteString -> WithinParens -> Markdown # typeDocDependencies :: Proxy ByteString -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep ByteString # typeDocMichelsonRep :: TypeDocMichelsonRep ByteString #
TypeHasDoc Address
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Address :: FieldDescriptions # Methods typeDocName :: Proxy Address -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Address -> WithinParens -> Markdown # typeDocDependencies :: Proxy Address -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Address # typeDocMichelsonRep :: TypeDocMichelsonRep Address #
TypeHasDoc EpAddress
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions EpAddress :: FieldDescriptions # Methods typeDocName :: Proxy EpAddress -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown # typeDocDependencies :: Proxy EpAddress -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep EpAddress # typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress #
TypeHasDoc KeyHash
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions KeyHash :: FieldDescriptions # Methods typeDocName :: Proxy KeyHash -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy KeyHash -> WithinParens -> Markdown # typeDocDependencies :: Proxy KeyHash -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep KeyHash # typeDocMichelsonRep :: TypeDocMichelsonRep KeyHash #
TypeHasDoc MText
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions MText :: FieldDescriptions # Methods typeDocName :: Proxy MText -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy MText -> WithinParens -> Markdown # typeDocDependencies :: Proxy MText -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep MText # typeDocMichelsonRep :: TypeDocMichelsonRep MText #
TypeHasDoc Mutez
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Mutez :: FieldDescriptions # Methods typeDocName :: Proxy Mutez -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Mutez -> WithinParens -> Markdown # typeDocDependencies :: Proxy Mutez -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Mutez # typeDocMichelsonRep :: TypeDocMichelsonRep Mutez #
TypeHasDoc Operation
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Operation :: FieldDescriptions # Methods typeDocName :: Proxy Operation -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Operation -> WithinParens -> Markdown # typeDocDependencies :: Proxy Operation -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Operation # typeDocMichelsonRep :: TypeDocMichelsonRep Operation #
TypeHasDoc PublicKey
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions PublicKey :: FieldDescriptions # Methods typeDocName :: Proxy PublicKey -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy PublicKey -> WithinParens -> Markdown # typeDocDependencies :: Proxy PublicKey -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep PublicKey # typeDocMichelsonRep :: TypeDocMichelsonRep PublicKey #
TypeHasDoc Signature
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Signature :: FieldDescriptions # Methods typeDocName :: Proxy Signature -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Signature -> WithinParens -> Markdown # typeDocDependencies :: Proxy Signature -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Signature # typeDocMichelsonRep :: TypeDocMichelsonRep Signature #
TypeHasDoc Timestamp
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Timestamp :: FieldDescriptions # Methods typeDocName :: Proxy Timestamp -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Timestamp -> WithinParens -> Markdown # typeDocDependencies :: Proxy Timestamp -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Timestamp # typeDocMichelsonRep :: TypeDocMichelsonRep Timestamp #
TypeHasDoc Empty Source #
Instance details Defined in Lorentz.Empty Associated Types type TypeDocFieldDescriptions Empty :: FieldDescriptions # Methods typeDocName :: Proxy Empty -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Empty -> WithinParens -> Markdown # typeDocDependencies :: Proxy Empty -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Empty # typeDocMichelsonRep :: TypeDocMichelsonRep Empty #
PolyTypeHasDocC '[a] => TypeHasDoc [a]
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions [a] :: FieldDescriptions # Methods typeDocName :: Proxy [a] -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy [a] -> WithinParens -> Markdown # typeDocDependencies :: Proxy [a] -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep [a] # typeDocMichelsonRep :: TypeDocMichelsonRep [a] #
PolyTypeHasDocC '[a] => TypeHasDoc (Maybe a)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Maybe a) :: FieldDescriptions # Methods typeDocName :: Proxy (Maybe a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Maybe a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Maybe a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Maybe a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Maybe a) #
PolyCTypeHasDocC '[a] => TypeHasDoc (Set a)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Set a) :: FieldDescriptions # Methods typeDocName :: Proxy (Set a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Set a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Set a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Set a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Set a) #
PolyTypeHasDocC '[cp] => TypeHasDoc (ContractRef cp)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (ContractRef cp) :: FieldDescriptions # Methods typeDocName :: Proxy (ContractRef cp) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (ContractRef cp) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (ContractRef cp) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (ContractRef cp) # typeDocMichelsonRep :: TypeDocMichelsonRep (ContractRef cp) #
UStoreTemplateHasDoc template => TypeHasDoc (UStore template) Source #
Instance details Defined in Lorentz.UStore.Doc 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) #
(TypeHasDoc r, IsError (VoidResult r)) => TypeHasDoc (VoidResult r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (VoidResult r) :: FieldDescriptions # Methods typeDocName :: Proxy (VoidResult r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (VoidResult r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (VoidResult r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (VoidResult r) # typeDocMichelsonRep :: TypeDocMichelsonRep (VoidResult r) #
Typeable interface => TypeHasDoc (UParam interface) Source #
Instance details Defined in Lorentz.UParam Associated Types type TypeDocFieldDescriptions (UParam interface) :: FieldDescriptions # Methods typeDocName :: Proxy (UParam interface) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (UParam interface) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (UParam interface) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (UParam interface) # typeDocMichelsonRep :: TypeDocMichelsonRep (UParam interface) #
PolyTypeHasDocC '[l, r] => TypeHasDoc (Either l r)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Either l r) :: FieldDescriptions # Methods typeDocName :: Proxy (Either l r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Either l r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Either l r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Either l r) # typeDocMichelsonRep :: TypeDocMichelsonRep (Either l r) #
PolyTypeHasDocC '[a, b] => TypeHasDoc (a, b)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (Map k v)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Map k v) :: FieldDescriptions # Methods typeDocName :: Proxy (Map k v) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Map k v) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Map k v) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Map k v) # typeDocMichelsonRep :: TypeDocMichelsonRep (Map k v) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (BigMap k v)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (BigMap k v) :: FieldDescriptions # Methods typeDocName :: Proxy (BigMap k v) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (BigMap k v) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (BigMap k v) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (BigMap k v) # typeDocMichelsonRep :: TypeDocMichelsonRep (BigMap k v) #
Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (i :-> o) Source #
Instance details Defined in Lorentz.Doc Associated Types type TypeDocFieldDescriptions (i :-> o) :: FieldDescriptions # Methods typeDocName :: Proxy (i :-> o) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (i :-> o) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (i :-> o) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (i :-> o) # typeDocMichelsonRep :: TypeDocMichelsonRep (i :-> o) #
Each '[Typeable :: Type -> Constraint, UStoreTemplateHasDoc] '[oldStore, newStore] => TypeHasDoc (MigrationScript oldStore newStore) Source #
Instance details Defined in Lorentz.UStore.Migration.Base Associated Types type TypeDocFieldDescriptions (MigrationScript oldStore newStore) :: FieldDescriptions # Methods typeDocName :: Proxy (MigrationScript oldStore newStore) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (MigrationScript oldStore newStore) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (MigrationScript oldStore newStore) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (MigrationScript oldStore newStore) # typeDocMichelsonRep :: TypeDocMichelsonRep (MigrationScript oldStore newStore) #
Each '[Typeable :: Type -> Constraint, TypeHasDoc] '[a, r] => TypeHasDoc (Void_ a r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (Void_ a r) :: FieldDescriptions # Methods typeDocName :: Proxy (Void_ a r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Void_ a r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Void_ a r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Void_ a r) # typeDocMichelsonRep :: TypeDocMichelsonRep (Void_ a r) #
Each '[Typeable :: Type -> Constraint, TypeHasDoc] '[a, r] => TypeHasDoc (View a r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (View a r) :: FieldDescriptions # Methods typeDocName :: Proxy (View a r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (View a r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (View a r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (View a r) # typeDocMichelsonRep :: TypeDocMichelsonRep (View a r) #
(ExtensibleHasDoc x, ReifyList DocumentCtor (EnumerateCtors (GetCtors x))) => TypeHasDoc (Extensible x) Source #
Instance details Defined in Lorentz.Extensible Associated Types type TypeDocFieldDescriptions (Extensible x) :: FieldDescriptions # Methods typeDocName :: Proxy (Extensible x) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Extensible x) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Extensible x) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Extensible x) # typeDocMichelsonRep :: TypeDocMichelsonRep (Extensible x) #
PolyTypeHasDocC '[a, b, c] => TypeHasDoc (a, b, c)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c) #
(TypeHasDoc (ApplyNamedFunctor f a), KnownSymbol n, SingI (ToT (ApplyNamedFunctor f Integer)), Typeable f, Typeable a) => TypeHasDoc (NamedF f a n)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (NamedF f a n) :: FieldDescriptions # Methods typeDocName :: Proxy (NamedF f a n) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (NamedF f a n) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (NamedF f a n) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (NamedF f a n) # typeDocMichelsonRep :: TypeDocMichelsonRep (NamedF f a n) #
PolyTypeHasDocC '[a, b, c, d] => TypeHasDoc (a, b, c, d)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d) #
PolyTypeHasDocC '[a, b, c, d, e] => TypeHasDoc (a, b, c, d, e)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e) #
PolyTypeHasDocC '[a, b, c, d, e, f] => TypeHasDoc (a, b, c, d, e, f)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e, f) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e, f) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e, f) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e, f) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e, f) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e, f) #
PolyTypeHasDocC '[a, b, c, d, e, f, g] => TypeHasDoc (a, b, c, d, e, f, g)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e, f, g) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e, f, g) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e, f, g) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e, f, g) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e, f, g) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e, f, g) #

data SomeTypeWithDoc where #

Constructors

SomeTypeWithDoc :: forall td. TypeHasDoc td => Proxy td -> SomeTypeWithDoc

class HaveCommonTypeCtor (a :: k) (b :: k1) #

Instances

Instances details

HaveCommonTypeCtor (a :: k) (a :: k)
Instance details Defined in Michelson.Typed.Haskell.Doc
HaveCommonTypeCtor ac bc => HaveCommonTypeCtor (ac a :: k2) (bc b :: k4)
Instance details Defined in Michelson.Typed.Haskell.Doc

class IsHomomorphic (a :: k) #

Instances

Instances details

IsHomomorphic (a :: k)
Instance details Defined in Michelson.Typed.Haskell.Doc
(TypeError ('Text "Type is not homomorphic: " :<>: 'ShowType (a b)) :: Constraint) => IsHomomorphic (a b :: k2)
Instance details Defined in Michelson.Typed.Haskell.Doc

genericTypeDocDependencies :: (Generic a, GTypeHasDoc (Rep a)) => Proxy a -> [SomeDocDefinitionItem] #

customTypeDocMdReference :: (Text, DType) -> [DType] -> WithinParens -> Markdown #

homomorphicTypeDocMdReference :: (Typeable t, TypeHasDoc t, IsHomomorphic t) => Proxy t -> WithinParens -> Markdown #

poly1TypeDocMdReference :: forall (t :: Type -> Type) r a. (r ~ t a, Typeable t, Each '[TypeHasDoc] '[r, a], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown #

poly2TypeDocMdReference :: forall (t :: Type -> Type -> Type) r a b. (r ~ t a b, Typeable t, Each '[TypeHasDoc] '[r, a, b], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown #

homomorphicTypeDocHaskellRep :: (Generic a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep a #

concreteTypeDocHaskellRep :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a), HaveCommonTypeCtor b a) => TypeDocHaskellRep b #

concreteTypeDocHaskellRepUnsafe :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep b #

haskellAddNewtypeField :: Text -> TypeDocHaskellRep a -> TypeDocHaskellRep a #

haskellRepNoFields :: TypeDocHaskellRep a -> TypeDocHaskellRep a #

haskellRepStripFieldPrefix :: HasCallStack => TypeDocHaskellRep a -> TypeDocHaskellRep a #

homomorphicTypeDocMichelsonRep :: SingI (ToT a) => TypeDocMichelsonRep a #

concreteTypeDocMichelsonRep :: forall k a (b :: k). (Typeable a, SingI (ToT a), HaveCommonTypeCtor b a) => TypeDocMichelsonRep b #

concreteTypeDocMichelsonRepUnsafe :: forall k a (b :: k). (Typeable a, SingI (ToT a)) => TypeDocMichelsonRep b #

mdTocFromRef :: (DocItem d, DocItemReferenced d ~ 'True) => HeaderLevel -> Markdown -> d -> Markdown #

Orphan instances

Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (i :-> o) Source #

Instance details

Associated Types

type TypeDocFieldDescriptions (i :-> o) :: FieldDescriptions #

Methods

typeDocName :: Proxy (i :-> o) -> Text #

typeDocMdDescription :: Markdown #

typeDocMdReference :: Proxy (i :-> o) -> WithinParens -> Markdown #

typeDocDependencies :: Proxy (i :-> o) -> [SomeDocDefinitionItem] #

typeDocHaskellRep :: TypeDocHaskellRep (i :-> o) #

typeDocMichelsonRep :: TypeDocMichelsonRep (i :-> o) #