Safe Haskell	Safe-Inferred
Language	Haskell2010

Lorentz.Doc

Contents

Views
Re-exports
Orphan instances

Synopsis

doc :: DocItem di => di -> s :-> s
docGroup :: DocItem di => (SubDoc -> di) -> (inp :-> out) -> inp :-> out
dStorage :: TypeHasDoc store => DStorageType
contractGeneralDefault :: s :-> s
cutLorentzNonDoc :: (inp :-> out) -> s :-> s
data DView = DView {
- dvName :: ViewName
- dvSub :: SubDoc
}
data DViewArg = forall a.(NiceViewable a, TypeHasDoc a) => DViewArg (Proxy a)
data DViewRet = forall a.(NiceViewable a, TypeHasDoc a) => DViewRet (Proxy a)
data DViewDesc = forall vd.ViewsDescriptorHasDoc vd => DViewDesc (Proxy vd)
class (Typeable vd, RenderViewsImpl (RevealViews vd)) => ViewsDescriptorHasDoc (vd :: Type) where
- viewsDescriptorName :: Proxy vd -> Text
- renderViewsDescriptorDoc :: Proxy vd -> Builder
type Markdown = Builder
data DocElem d = DocElem {
- deItem :: d
- deSub :: Maybe SubDoc
}
class (Typeable d, DOrd d) => DocItem d where
- type DocItemPlacement d :: DocItemPlacementKind
- type DocItemReferenced d :: DocItemReferencedKind
- 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]
docItemPosition :: DocItem d => DocItemPos
newtype DocItemId = DocItemId Text
data DocItemPlacementKind
- = DocItemInlined
- | DocItemInDefinitions
newtype DocItemPos = DocItemPos (Natural, Text)
data DocItemRef (p :: DocItemPlacementKind) (r :: DocItemReferencedKind) where
- DocItemRef :: DocItemId -> DocItemRef 'DocItemInDefinitions 'True
- DocItemRefInlined :: DocItemId -> DocItemRef 'DocItemInlined 'True
- DocItemNoRef :: DocItemRef 'DocItemInlined 'False
data DocSection = DocItem d => DocSection (NonEmpty $ DocElem d)
data DocSectionNameStyle
- = DocSectionNameBig
- | DocSectionNameSmall
data SomeDocItem where
- SomeDocItem :: forall d. DocItem d => d -> SomeDocItem
data SomeDocDefinitionItem where
- SomeDocDefinitionItem :: forall d. (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => d -> SomeDocDefinitionItem
newtype SubDoc = SubDoc DocBlock
type DocGrouping = SubDoc -> SomeDocItem
data ContractDoc = ContractDoc {
- cdContents :: DocBlock
- cdDefinitions :: DocBlock
- cdDefinitionsSet :: Set SomeDocDefinitionItem
- cdDefinitionIds :: Set DocItemId
}
newtype DGeneralInfoSection = DGeneralInfoSection SubDoc
data DName = DName Text SubDoc
data DDescription = DDescription Markdown
data DEntrypointExample = forall t.ParameterScope t => DEntrypointExample (Value t)
mkDEntrypointExample :: forall a. NiceParameter a => a -> DEntrypointExample
data DGitRevision
- = DGitRevisionKnown DGitRevisionInfo
- | DGitRevisionUnknown
newtype GitRepoSettings = GitRepoSettings {
- grsMkGitRevision :: Text -> Text
}
mkDGitRevision :: ExpQ
morleyRepoSettings :: GitRepoSettings
data DComment = DComment Text
data DAnchor = DAnchor Anchor
data DType where
- DType :: forall a. TypeHasDoc a => Proxy a -> DType
dTypeDep :: TypeHasDoc t => SomeDocDefinitionItem
docDefinitionRef :: (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => Markdown -> d -> Markdown
contractDocToMarkdown :: ContractDoc -> LText
subDocToMarkdown :: HeaderLevel -> SubDoc -> Markdown
docItemSectionRef :: DocItem di => Maybe Markdown
class ContainsDoc a where
- buildDocUnfinalized :: a -> ContractDoc
class ContainsDoc a => ContainsUpdateableDoc a where
- modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> a -> a
data WithFinalizedDoc a
finalizedAsIs :: a -> WithFinalizedDoc a
buildDoc :: ContainsDoc a => WithFinalizedDoc a -> ContractDoc
buildMarkdownDoc :: ContainsDoc a => WithFinalizedDoc a -> LText
modifyDoc :: (ContainsUpdateableDoc a, DocItem i1, DocItem i2) => (i1 -> Maybe i2) -> a -> a
attachDocCommons :: ContainsUpdateableDoc a => DGitRevision -> a -> WithFinalizedDoc a
class (Typeable a, SingI (TypeDocFieldDescriptions a), FieldDescriptionsValid (TypeDocFieldDescriptions a) a) => TypeHasDoc a where
- type TypeDocFieldDescriptions a :: FieldDescriptions
- typeDocName :: Proxy a -> Text
- typeDocMdDescription :: Markdown
- typeDocMdReference :: Proxy a -> WithinParens -> Markdown
- typeDocDependencies :: Proxy a -> [SomeDocDefinitionItem]
- typeDocHaskellRep :: TypeDocHaskellRep a
- typeDocMichelsonRep :: TypeDocMichelsonRep a
data SomeTypeWithDoc where
- SomeTypeWithDoc :: forall td. TypeHasDoc td => Proxy td -> SomeTypeWithDoc
typeDocBuiltMichelsonRep :: TypeHasDoc a => Proxy a -> Builder
class HaveCommonTypeCtor (a :: k) (b :: k1)
class IsHomomorphic (a :: k)
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
unsafeConcreteTypeDocHaskellRep :: (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 :: KnownIsoT a => TypeDocMichelsonRep a
concreteTypeDocMichelsonRep :: forall {k} a (b :: k). (Typeable a, KnownIsoT a, HaveCommonTypeCtor b a) => TypeDocMichelsonRep b
unsafeConcreteTypeDocMichelsonRep :: forall {k} a (b :: k). (Typeable a, KnownIsoT a) => TypeDocMichelsonRep b
mdTocFromRef :: (DocItem d, DocItemReferenced d ~ 'True) => HeaderLevel -> Markdown -> d -> Markdown

Documentation

doc :: DocItem di => di -> s :-> s Source #

Put a document item.

docGroup :: DocItem di => (SubDoc -> di) -> (inp :-> out) -> inp :-> out Source #

Group documentation built in the given piece of code into block dedicated to one thing, e.g. to one entrypoint.

Examples of doc items you can pass here: DName, DGeneralInfoSection.

dStorage :: TypeHasDoc store => DStorageType #

contractGeneralDefault :: s :-> s Source #

Inserts general information about the contract using the default format.

This includes git revision and some other information common for all contracts. Git revision is left unknown in the library code and is supposed to be updated in an executable using e.g. attachDocCommons.

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.

Views

data DView Source #

Renders to a view section.

Constructors

DView
Fields dvName :: ViewName dvSub :: SubDoc

Instances

Instances details

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

data DViewArg Source #

Renders to a line mentioning the view's argument.

Constructors

forall a.(NiceViewable a, TypeHasDoc a) => DViewArg (Proxy a)

Instances

Instances details

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

data DViewRet Source #

Renders to a line mentioning the view's argument.

Constructors

forall a.(NiceViewable a, TypeHasDoc a) => DViewRet (Proxy a)

Instances

Instances details

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

data DViewDesc Source #

Renders to documentation of view descriptor.

Constructors

forall vd.ViewsDescriptorHasDoc vd => DViewDesc (Proxy vd)

Instances

Instances details

Eq DViewDesc Source #
Instance details Defined in Lorentz.Doc Methods (==) :: DViewDesc -> DViewDesc -> Bool # (/=) :: DViewDesc -> DViewDesc -> Bool #
Ord DViewDesc Source #
Instance details Defined in Lorentz.Doc Methods compare :: DViewDesc -> DViewDesc -> Ordering # (<) :: DViewDesc -> DViewDesc -> Bool # (<=) :: DViewDesc -> DViewDesc -> Bool # (>) :: DViewDesc -> DViewDesc -> Bool # (>=) :: DViewDesc -> DViewDesc -> Bool # max :: DViewDesc -> DViewDesc -> DViewDesc # min :: DViewDesc -> DViewDesc -> DViewDesc #
DocItem DViewDesc Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DViewDesc :: DocItemPlacementKind # type DocItemReferenced DViewDesc :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DViewDesc -> DocItemRef (DocItemPlacement DViewDesc) (DocItemReferenced DViewDesc) # docItemToMarkdown :: HeaderLevel -> DViewDesc -> Markdown # docItemToToc :: HeaderLevel -> DViewDesc -> Markdown # docItemDependencies :: DViewDesc -> [SomeDocDefinitionItem] # docItemsOrder :: [DViewDesc] -> [DViewDesc] #
type DocItemPlacement DViewDesc Source #
Instance details Defined in Lorentz.Doc type DocItemPlacement DViewDesc = 'DocItemInDefinitions
type DocItemReferenced DViewDesc Source #
Instance details Defined in Lorentz.Doc type DocItemReferenced DViewDesc = 'True

class (Typeable vd, RenderViewsImpl (RevealViews vd)) => ViewsDescriptorHasDoc (vd :: Type) where Source #

Provides documentation for views descriptor.

Note that views descriptors may describe views that do not belong to the current contract, e.g. TAddress may refer to an external contract provided by the user in which we want to call a view.

Minimal complete definition

Nothing

Methods

viewsDescriptorName :: Proxy vd -> Text Source #

default viewsDescriptorName :: (Generic vd, KnownSymbol (GenericTypeName vd)) => Proxy vd -> Text Source #

renderViewsDescriptorDoc :: Proxy vd -> Builder Source #

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 DHashAlgorithm Source #
Instance details Defined in Lorentz.Bytes Associated Types type DocItemPlacement DHashAlgorithm :: DocItemPlacementKind # type DocItemReferenced DHashAlgorithm :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DHashAlgorithm -> DocItemRef (DocItemPlacement DHashAlgorithm) (DocItemReferenced DHashAlgorithm) # docItemToMarkdown :: HeaderLevel -> DHashAlgorithm -> Markdown # docItemToToc :: HeaderLevel -> DHashAlgorithm -> Markdown # docItemDependencies :: DHashAlgorithm -> [SomeDocDefinitionItem] # docItemsOrder :: [DHashAlgorithm] -> [DHashAlgorithm] #
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 DView Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DView :: DocItemPlacementKind # type DocItemReferenced DView :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DView -> DocItemRef (DocItemPlacement DView) (DocItemReferenced DView) # docItemToMarkdown :: HeaderLevel -> DView -> Markdown # docItemToToc :: HeaderLevel -> DView -> Markdown # docItemDependencies :: DView -> [SomeDocDefinitionItem] # docItemsOrder :: [DView] -> [DView] #
DocItem DViewArg Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DViewArg :: DocItemPlacementKind # type DocItemReferenced DViewArg :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DViewArg -> DocItemRef (DocItemPlacement DViewArg) (DocItemReferenced DViewArg) # docItemToMarkdown :: HeaderLevel -> DViewArg -> Markdown # docItemToToc :: HeaderLevel -> DViewArg -> Markdown # docItemDependencies :: DViewArg -> [SomeDocDefinitionItem] # docItemsOrder :: [DViewArg] -> [DViewArg] #
DocItem DViewDesc Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DViewDesc :: DocItemPlacementKind # type DocItemReferenced DViewDesc :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DViewDesc -> DocItemRef (DocItemPlacement DViewDesc) (DocItemReferenced DViewDesc) # docItemToMarkdown :: HeaderLevel -> DViewDesc -> Markdown # docItemToToc :: HeaderLevel -> DViewDesc -> Markdown # docItemDependencies :: DViewDesc -> [SomeDocDefinitionItem] # docItemsOrder :: [DViewDesc] -> [DViewDesc] #
DocItem DViewRet Source #
Instance details Defined in Lorentz.Doc Associated Types type DocItemPlacement DViewRet :: DocItemPlacementKind # type DocItemReferenced DViewRet :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DViewRet -> DocItemRef (DocItemPlacement DViewRet) (DocItemReferenced DViewRet) # docItemToMarkdown :: HeaderLevel -> DViewRet -> Markdown # docItemToToc :: HeaderLevel -> DViewRet -> Markdown # docItemDependencies :: DViewRet -> [SomeDocDefinitionItem] # docItemsOrder :: [DViewRet] -> [DViewRet] #
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 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 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 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 DAnchor
Instance details Defined in Morley.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 Morley.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 DConversionInfo
Instance details Defined in Morley.Michelson.Doc Associated Types type DocItemPlacement DConversionInfo :: DocItemPlacementKind # type DocItemReferenced DConversionInfo :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DConversionInfo -> DocItemRef (DocItemPlacement DConversionInfo) (DocItemReferenced DConversionInfo) # docItemToMarkdown :: HeaderLevel -> DConversionInfo -> Markdown # docItemToToc :: HeaderLevel -> DConversionInfo -> Markdown # docItemDependencies :: DConversionInfo -> [SomeDocDefinitionItem] # docItemsOrder :: [DConversionInfo] -> [DConversionInfo] #
DocItem DDescription
Instance details Defined in Morley.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 Morley.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 Morley.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 Morley.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 Morley.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 DStorageType
Instance details Defined in Morley.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 Morley.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] #
EntrypointKindHasDoc ep => DocItem (DEntrypoint ep) Source #
Instance details Defined in Lorentz.Entrypoints.Doc Associated Types type DocItemPlacement (DEntrypoint ep) :: DocItemPlacementKind # type DocItemReferenced (DEntrypoint ep) :: DocItemReferencedKind # Methods docItemPos :: Natural # docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntrypoint ep -> DocItemRef (DocItemPlacement (DEntrypoint ep)) (DocItemReferenced (DEntrypoint ep)) # docItemToMarkdown :: HeaderLevel -> DEntrypoint ep -> Markdown # docItemToToc :: HeaderLevel -> DEntrypoint ep -> Markdown # docItemDependencies :: DEntrypoint ep -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntrypoint ep] -> [DEntrypoint ep] #

docItemPosition :: DocItem d => DocItemPos #

newtype DocItemId #

Constructors

DocItemId Text

Instances

Instances details

Show DocItemId
Instance details Defined in Morley.Michelson.Doc Methods showsPrec :: Int -> DocItemId -> ShowS # show :: DocItemId -> String # showList :: [DocItemId] -> ShowS #
Eq DocItemId
Instance details Defined in Morley.Michelson.Doc Methods (==) :: DocItemId -> DocItemId -> Bool # (/=) :: DocItemId -> DocItemId -> Bool #
Ord DocItemId
Instance details Defined in Morley.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 #
ToAnchor DocItemId
Instance details Defined in Morley.Michelson.Doc Methods toAnchor :: DocItemId -> Anchor

data DocItemPlacementKind #

Constructors

DocItemInlined
DocItemInDefinitions

newtype DocItemPos #

Constructors

DocItemPos (Natural, Text)

Instances

Instances details

Show DocItemPos
Instance details Defined in Morley.Michelson.Doc Methods showsPrec :: Int -> DocItemPos -> ShowS # show :: DocItemPos -> String # showList :: [DocItemPos] -> ShowS #
Buildable DocItemPos
Instance details Defined in Morley.Michelson.Doc Methods build :: DocItemPos -> Builder #
Eq DocItemPos
Instance details Defined in Morley.Michelson.Doc Methods (==) :: DocItemPos -> DocItemPos -> Bool # (/=) :: DocItemPos -> DocItemPos -> Bool #
Ord DocItemPos
Instance details Defined in Morley.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 #

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 Morley.Michelson.Doc Methods toAnchor :: DocItemRef d 'True -> Anchor

data DocSection #

Constructors

DocItem d => DocSection (NonEmpty $ DocElem d)

data DocSectionNameStyle #

Constructors

DocSectionNameBig
DocSectionNameSmall

data SomeDocItem where #

Constructors

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

Instances

Instances details

Show DocGrouping
Instance details Defined in Morley.Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #
Show SomeDocItem
Instance details Defined in Morley.Michelson.Doc Methods showsPrec :: Int -> SomeDocItem -> ShowS # show :: SomeDocItem -> String # showList :: [SomeDocItem] -> ShowS #
NFData SomeDocItem
Instance details Defined in Morley.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 Morley.Michelson.Doc Methods (==) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (/=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool #
Ord SomeDocDefinitionItem
Instance details Defined in Morley.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 Morley.Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #
di ~ DName => IsString (SubDoc -> di)
Instance details Defined in Morley.Michelson.Doc Methods fromString :: String -> SubDoc -> di #

type DocGrouping = SubDoc -> SomeDocItem #

data ContractDoc #

Constructors

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

Instances

Instances details

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

newtype DGeneralInfoSection #

Constructors

DGeneralInfoSection SubDoc

Instances

Instances details

DocItem DGeneralInfoSection
Instance details Defined in Morley.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] #
type DocItemPlacement DGeneralInfoSection
Instance details Defined in Morley.Michelson.Doc type DocItemPlacement DGeneralInfoSection = 'DocItemInlined
type DocItemReferenced DGeneralInfoSection
Instance details Defined in Morley.Michelson.Doc type DocItemReferenced DGeneralInfoSection = 'False

data DName #

Constructors

DName Text SubDoc

Instances

Instances details

DocItem DName
Instance details Defined in Morley.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] #
type DocItemPlacement DName
Instance details Defined in Morley.Michelson.Doc type DocItemPlacement DName = 'DocItemInlined
type DocItemReferenced DName
Instance details Defined in Morley.Michelson.Doc type DocItemReferenced DName = 'False

data DDescription #

Constructors

DDescription Markdown

Instances

Instances details

DocItem DDescription
Instance details Defined in Morley.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 Morley.Michelson.Doc type DocItemPlacement DDescription = 'DocItemInlined
type DocItemReferenced DDescription
Instance details Defined in Morley.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 Morley.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 Morley.Michelson.Doc type DocItemPlacement DGitRevision = 'DocItemInlined
type DocItemReferenced DGitRevision
Instance details Defined in Morley.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 Morley.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 Morley.Michelson.Doc type DocItemPlacement DComment = 'DocItemInlined
type DocItemReferenced DComment
Instance details Defined in Morley.Michelson.Doc type DocItemReferenced DComment = 'False

data DAnchor #

Constructors

DAnchor Anchor

Instances

Instances details

DocItem DAnchor
Instance details Defined in Morley.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 Morley.Michelson.Doc type DocItemPlacement DAnchor = 'DocItemInlined
type DocItemReferenced DAnchor
Instance details Defined in Morley.Michelson.Doc type DocItemReferenced DAnchor = 'False

data DType where #

Constructors

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

Instances

Instances details

Buildable DType
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Methods build :: DType -> Builder #
Eq DType
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Methods (==) :: DType -> DType -> Bool # (/=) :: DType -> DType -> Bool #
Ord DType
Instance details Defined in Morley.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 #
DocItem DType
Instance details Defined in Morley.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 Morley.Michelson.Typed.Haskell.Doc type DocItemPlacement DType = 'DocItemInDefinitions
type DocItemReferenced DType
Instance details Defined in Morley.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 #

docItemSectionRef :: DocItem di => Maybe Markdown #

class ContainsDoc a where #

Methods

buildDocUnfinalized :: a -> ContractDoc #

Instances

Instances details

ContainsDoc (i :-> o) Source #
Instance details Defined in Lorentz.Doc Methods buildDocUnfinalized :: (i :-> o) -> ContractDoc #
ContainsDoc (ContractCode i o) Source #
Instance details Defined in Lorentz.Doc Methods buildDocUnfinalized :: ContractCode i o -> ContractDoc #
ContainsDoc (Contract cp st vd) Source #
Instance details Defined in Lorentz.Doc Methods buildDocUnfinalized :: Contract cp st vd -> ContractDoc #
ContainsDoc (ContractData cp st vd) Source #
Instance details Defined in Lorentz.Run Methods buildDocUnfinalized :: ContractData cp st vd -> ContractDoc #

class ContainsDoc a => ContainsUpdateableDoc a where #

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> a -> a #

Instances

Instances details

ContainsUpdateableDoc (i :-> o) Source #
Instance details Defined in Lorentz.Doc Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> (i :-> o) -> i :-> o #
ContainsUpdateableDoc (ContractCode i o) Source #
Instance details Defined in Lorentz.Doc Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> ContractCode i o -> ContractCode i o #
ContainsUpdateableDoc (Contract cp st vd) Source #
Instance details Defined in Lorentz.Doc Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> Contract cp st vd -> Contract cp st vd #
ContainsUpdateableDoc (ContractData cp st vd) Source #
Instance details Defined in Lorentz.Run Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> ContractData cp st vd -> ContractData cp st vd #

data WithFinalizedDoc a #

Instances

Instances details

Applicative WithFinalizedDoc
Instance details Defined in Morley.Michelson.Doc Methods pure :: a -> WithFinalizedDoc a # (<>) :: WithFinalizedDoc (a -> b) -> WithFinalizedDoc a -> WithFinalizedDoc b # liftA2 :: (a -> b -> c) -> WithFinalizedDoc a -> WithFinalizedDoc b -> WithFinalizedDoc c # (>) :: WithFinalizedDoc a -> WithFinalizedDoc b -> WithFinalizedDoc b # (<*) :: WithFinalizedDoc a -> WithFinalizedDoc b -> WithFinalizedDoc a #
Functor WithFinalizedDoc
Instance details Defined in Morley.Michelson.Doc Methods fmap :: (a -> b) -> WithFinalizedDoc a -> WithFinalizedDoc b # (<$) :: a -> WithFinalizedDoc b -> WithFinalizedDoc a #
Monad WithFinalizedDoc
Instance details Defined in Morley.Michelson.Doc Methods (>>=) :: WithFinalizedDoc a -> (a -> WithFinalizedDoc b) -> WithFinalizedDoc b # (>>) :: WithFinalizedDoc a -> WithFinalizedDoc b -> WithFinalizedDoc b # return :: a -> WithFinalizedDoc a #

finalizedAsIs :: a -> WithFinalizedDoc a #

buildDoc :: ContainsDoc a => WithFinalizedDoc a -> ContractDoc #

buildMarkdownDoc :: ContainsDoc a => WithFinalizedDoc a -> LText #

modifyDoc :: (ContainsUpdateableDoc a, DocItem i1, DocItem i2) => (i1 -> Maybe i2) -> a -> a #

attachDocCommons :: ContainsUpdateableDoc a => DGitRevision -> a -> WithFinalizedDoc a #

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 ByteString
Instance details Defined in Morley.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 Never Source #
Instance details Defined in Lorentz.Value Associated Types type TypeDocFieldDescriptions Never :: FieldDescriptions # Methods typeDocName :: Proxy Never -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Never -> WithinParens -> Markdown # typeDocDependencies :: Proxy Never -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Never # typeDocMichelsonRep :: TypeDocMichelsonRep Never #
TypeHasDoc OpenChest Source #
Instance details Defined in Lorentz.Value Associated Types type TypeDocFieldDescriptions OpenChest :: FieldDescriptions # Methods typeDocName :: Proxy OpenChest -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy OpenChest -> WithinParens -> Markdown # typeDocDependencies :: Proxy OpenChest -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep OpenChest # typeDocMichelsonRep :: TypeDocMichelsonRep OpenChest #
TypeHasDoc MText
Instance details Defined in Morley.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 Operation
Instance details Defined in Morley.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 EpAddress
Instance details Defined in Morley.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 Address
Instance details Defined in Morley.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 ChainId
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions ChainId :: FieldDescriptions # Methods typeDocName :: Proxy ChainId -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy ChainId -> WithinParens -> Markdown # typeDocDependencies :: Proxy ChainId -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep ChainId # typeDocMichelsonRep :: TypeDocMichelsonRep ChainId #
TypeHasDoc Mutez
Instance details Defined in Morley.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 Timestamp
Instance details Defined in Morley.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 KeyHash
Instance details Defined in Morley.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 PublicKey
Instance details Defined in Morley.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 Morley.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 Chest
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Chest :: FieldDescriptions # Methods typeDocName :: Proxy Chest -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Chest -> WithinParens -> Markdown # typeDocDependencies :: Proxy Chest -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Chest # typeDocMichelsonRep :: TypeDocMichelsonRep Chest #
TypeHasDoc ChestKey
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions ChestKey :: FieldDescriptions # Methods typeDocName :: Proxy ChestKey -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy ChestKey -> WithinParens -> Markdown # typeDocDependencies :: Proxy ChestKey -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep ChestKey # typeDocMichelsonRep :: TypeDocMichelsonRep ChestKey #
TypeHasDoc Integer
Instance details Defined in Morley.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 Morley.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 Morley.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 Bool
Instance details Defined in Morley.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 #
PolyCTypeHasDocC '[a] => TypeHasDoc (Set a)
Instance details Defined in Morley.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) #
TypeHasDoc p => TypeHasDoc (FutureContract p) Source #
Instance details Defined in Lorentz.Doc Associated Types type TypeDocFieldDescriptions (FutureContract p) :: FieldDescriptions # Methods typeDocName :: Proxy (FutureContract p) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (FutureContract p) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (FutureContract p) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (FutureContract p) # typeDocMichelsonRep :: TypeDocMichelsonRep (FutureContract p) #
TypeHasDoc a => TypeHasDoc (ChestT a) Source #
Instance details Defined in Lorentz.Bytes Associated Types type TypeDocFieldDescriptions (ChestT a) :: FieldDescriptions # Methods typeDocName :: Proxy (ChestT a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (ChestT a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (ChestT a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (ChestT a) # typeDocMichelsonRep :: TypeDocMichelsonRep (ChestT a) #
TypeHasDoc a => TypeHasDoc (OpenChestT a) Source #
Instance details Defined in Lorentz.Bytes Associated Types type TypeDocFieldDescriptions (OpenChestT a) :: FieldDescriptions # Methods typeDocName :: Proxy (OpenChestT a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (OpenChestT a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (OpenChestT a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (OpenChestT a) # typeDocMichelsonRep :: TypeDocMichelsonRep (OpenChestT a) #
TypeHasDoc a => TypeHasDoc (Packed a) Source #
Instance details Defined in Lorentz.Bytes Associated Types type TypeDocFieldDescriptions (Packed a) :: FieldDescriptions # Methods typeDocName :: Proxy (Packed a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Packed a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Packed a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Packed a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Packed a) #
TypeHasDoc a => TypeHasDoc (TSignature a) Source #
Instance details Defined in Lorentz.Bytes Associated Types type TypeDocFieldDescriptions (TSignature a) :: FieldDescriptions # Methods typeDocName :: Proxy (TSignature a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (TSignature a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (TSignature a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (TSignature a) # typeDocMichelsonRep :: TypeDocMichelsonRep (TSignature a) #
(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 '[cp] => TypeHasDoc (ContractRef cp)
Instance details Defined in Morley.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) #
PolyTypeHasDocC '[a] => TypeHasDoc (Ticket a)
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Ticket a) :: FieldDescriptions # Methods typeDocName :: Proxy (Ticket a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Ticket a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Ticket a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Ticket a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Ticket a) #
PolyTypeHasDocC '[a] => TypeHasDoc (Maybe a)
Instance details Defined in Morley.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) #
PolyTypeHasDocC '[a] => TypeHasDoc [a]
Instance details Defined in Morley.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 '[l, r] => TypeHasDoc (Either l r)
Instance details Defined in Morley.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) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (Map k v)
Instance details Defined in Morley.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) #
(TypeHasDoc p, ViewsDescriptorHasDoc vd) => TypeHasDoc (TAddress p vd) Source #
Instance details Defined in Lorentz.Doc Associated Types type TypeDocFieldDescriptions (TAddress p vd) :: FieldDescriptions # Methods typeDocName :: Proxy (TAddress p vd) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (TAddress p vd) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (TAddress p vd) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (TAddress p vd) # typeDocMichelsonRep :: TypeDocMichelsonRep (TAddress p vd) #
(KnownHashAlgorithm alg, TypeHasDoc a) => TypeHasDoc (Hash alg a) Source #
Instance details Defined in Lorentz.Bytes Associated Types type TypeDocFieldDescriptions (Hash alg a) :: FieldDescriptions # Methods typeDocName :: Proxy (Hash alg a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Hash alg a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Hash alg a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Hash alg a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Hash alg a) #
(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) #
Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (WrappedLambda i o) Source #
Instance details Defined in Lorentz.Doc Associated Types type TypeDocFieldDescriptions (WrappedLambda i o) :: FieldDescriptions # Methods typeDocName :: Proxy (WrappedLambda i o) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (WrappedLambda i o) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (WrappedLambda i o) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (WrappedLambda i o) # typeDocMichelsonRep :: TypeDocMichelsonRep (WrappedLambda i o) #
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) #
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) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (BigMap k v)
Instance details Defined in Morley.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) #
PolyTypeHasDocC '[a, b] => TypeHasDoc (a, b)
Instance details Defined in Morley.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) #
(Typeable k, Typeable action, TypeHasDoc td) => TypeHasDoc (STicket action td) Source #
Instance details Defined in Lorentz.Tickets Associated Types type TypeDocFieldDescriptions (STicket action td) :: FieldDescriptions # Methods typeDocName :: Proxy (STicket action td) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (STicket action td) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (STicket action td) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (STicket action td) # typeDocMichelsonRep :: TypeDocMichelsonRep (STicket action td) #
(TypeHasDoc (ApplyNamedFunctor f a), KnownSymbol n, KnownIsoT (ApplyNamedFunctor f Integer), Typeable f, Typeable a) => TypeHasDoc (NamedF f a n)
Instance details Defined in Morley.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] => TypeHasDoc (a, b, c)
Instance details Defined in Morley.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) #
PolyTypeHasDocC '[a, b, c, d] => TypeHasDoc (a, b, c, d)
Instance details Defined in Morley.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 Morley.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 Morley.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 Morley.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

typeDocBuiltMichelsonRep :: TypeHasDoc a => Proxy a -> Builder #

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

Instances

Instances details

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

class IsHomomorphic (a :: k) #

Instances

Instances details

IsHomomorphic (a :: k)
Instance details Defined in Morley.Michelson.Typed.Haskell.Doc
(TypeError ('Text "Type is not homomorphic: " :<>: 'ShowType (a b)) :: Constraint) => IsHomomorphic (a b :: k2)
Instance details Defined in Morley.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 #

unsafeConcreteTypeDocHaskellRep :: (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 :: KnownIsoT a => TypeDocMichelsonRep a #

concreteTypeDocMichelsonRep :: forall {k} a (b :: k). (Typeable a, KnownIsoT a, HaveCommonTypeCtor b a) => TypeDocMichelsonRep b #

unsafeConcreteTypeDocMichelsonRep :: forall {k} a (b :: k). (Typeable a, KnownIsoT a) => TypeDocMichelsonRep b #

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

Orphan instances

TypeHasDoc p => TypeHasDoc (FutureContract p) Source #
Instance details Associated Types type TypeDocFieldDescriptions (FutureContract p) :: FieldDescriptions # Methods typeDocName :: Proxy (FutureContract p) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (FutureContract p) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (FutureContract p) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (FutureContract p) # typeDocMichelsonRep :: TypeDocMichelsonRep (FutureContract p) #
ContainsDoc (i :-> o) Source #
Instance details Methods buildDocUnfinalized :: (i :-> o) -> ContractDoc #
ContainsDoc (ContractCode i o) Source #
Instance details Methods buildDocUnfinalized :: ContractCode i o -> ContractDoc #
ContainsUpdateableDoc (i :-> o) Source #
Instance details Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> (i :-> o) -> i :-> o #
ContainsUpdateableDoc (ContractCode i o) Source #
Instance details Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> ContractCode i o -> ContractCode i o #
(TypeHasDoc p, ViewsDescriptorHasDoc vd) => TypeHasDoc (TAddress p vd) Source #
Instance details Associated Types type TypeDocFieldDescriptions (TAddress p vd) :: FieldDescriptions # Methods typeDocName :: Proxy (TAddress p vd) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (TAddress p vd) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (TAddress p vd) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (TAddress p vd) # typeDocMichelsonRep :: TypeDocMichelsonRep (TAddress p vd) #
Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (WrappedLambda i o) Source #
Instance details Associated Types type TypeDocFieldDescriptions (WrappedLambda i o) :: FieldDescriptions # Methods typeDocName :: Proxy (WrappedLambda i o) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (WrappedLambda i o) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (WrappedLambda i o) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (WrappedLambda i o) # typeDocMichelsonRep :: TypeDocMichelsonRep (WrappedLambda i o) #
ContainsDoc (Contract cp st vd) Source #
Instance details Methods buildDocUnfinalized :: Contract cp st vd -> ContractDoc #
ContainsUpdateableDoc (Contract cp st vd) Source #
Instance details Methods modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> Contract cp st vd -> Contract cp st vd #