Lorentz.Doc

Documentation

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

Put a document item.

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

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

docStorage :: forall storage s. TypeHasDoc storage => s :-> s

Deprecated: Use `doc (dStorage @storage)` instead.

Insert documentation of the contract storage type. The type should be passed using type applications.

buildLorentzDoc :: (inp :-> out) -> ContractDoc

Deprecated: Use buildDoc instead.

buildLorentzDocWithGitRev :: DGitRevision -> (inp :-> out) -> ContractDoc

Deprecated: Use `buildDoc . attachDocCommons gitRev` instead.

renderLorentzDoc :: (inp :-> out) -> LText

Deprecated: Use buildMarkdownDoc instead.

renderLorentzDocWithGitRev :: DGitRevision -> (inp :-> out) -> LText

Deprecated: Use `buildMarkdownDoc . attachDocCommons gitRev` instead.

contractName :: Text -> (inp :-> out) -> inp :-> out

Deprecated: Use `docGroup name` instead.

Give a name to given contract. Apply it to the whole contract code.

contractGeneral :: (inp :-> out) -> inp :-> out

Deprecated: Use `docGroup DGeneralInfoSection` instead.

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

contractGeneralDefault :: s :-> s

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. buildLorentzDocWithGitRev.

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

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

DocItem DStorageType

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

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 DGitRevision

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 DAnchor

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

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 DConversionInfo

Defined in 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

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

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 DName

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

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

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 DHashAlgorithm

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 DEntrypointArg

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

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 DThrows

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

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 DDescribeErrorTagMap

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]

EntrypointKindHasDoc ep => DocItem (DEntrypoint ep)

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

Eq DocItemId

Defined in Michelson.Doc

Methods

(==) :: DocItemId -> DocItemId -> Bool

(/=) :: DocItemId -> DocItemId -> Bool

Ord DocItemId

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

Defined in Michelson.Doc

Methods

showsPrec :: Int -> DocItemId -> ShowS

show :: DocItemId -> String

showList :: [DocItemId] -> ShowS

ToAnchor DocItemId

Defined in Michelson.Doc

Methods

toAnchor :: DocItemId -> Anchor

data DocItemPlacementKind

Constructors

DocItemInlined

DocItemInDefinitions

newtype DocItemPos

Constructors

DocItemPos (Natural, Text)

Instances

Eq DocItemPos

Defined in Michelson.Doc

Methods

(==) :: DocItemPos -> DocItemPos -> Bool

(/=) :: DocItemPos -> DocItemPos -> Bool

Ord DocItemPos

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

Defined in Michelson.Doc

Methods

showsPrec :: Int -> DocItemPos -> ShowS

show :: DocItemPos -> String

showList :: [DocItemPos] -> ShowS

Buildable DocItemPos

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

ToAnchor (DocItemRef d 'True)

Defined in Michelson.Doc

Methods

toAnchor :: DocItemRef d 'True -> Anchor

data DocSection

Constructors

DocItem d => DocSection (NonEmpty $ DocElem d)

Instances

Show DocSection

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

Show SomeDocItem

Defined in Michelson.Doc

Methods

showsPrec :: Int -> SomeDocItem -> ShowS

show :: SomeDocItem -> String

showList :: [SomeDocItem] -> ShowS

Show DocGrouping

Defined in Michelson.Doc

Methods

showsPrec :: Int -> DocGrouping -> ShowS

show :: DocGrouping -> String

showList :: [DocGrouping] -> ShowS

NFData SomeDocItem

Defined in Michelson.Doc

Methods

rnf :: SomeDocItem -> ()

data SomeDocDefinitionItem where

Constructors

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

Instances

Eq SomeDocDefinitionItem

Defined in Michelson.Doc

Methods

(==) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool

(/=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool

Ord SomeDocDefinitionItem

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

Show DocGrouping

Defined in Michelson.Doc

Methods

showsPrec :: Int -> DocGrouping -> ShowS

show :: DocGrouping -> String

showList :: [DocGrouping] -> ShowS

di ~ DName => IsString (SubDoc -> di)

Defined in 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

Semigroup ContractDoc

Defined in Michelson.Doc

Methods

(<>) :: ContractDoc -> ContractDoc -> ContractDoc

sconcat :: NonEmpty ContractDoc -> ContractDoc

stimes :: Integral b => b -> ContractDoc -> ContractDoc

Monoid ContractDoc

Defined in Michelson.Doc

Methods

mempty :: ContractDoc

mappend :: ContractDoc -> ContractDoc -> ContractDoc

mconcat :: [ContractDoc] -> ContractDoc

newtype DGeneralInfoSection

Constructors

DGeneralInfoSection SubDoc

Instances

DocItem DGeneralInfoSection

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]

type DocItemPlacement DGeneralInfoSection

Defined in Michelson.Doc

type DocItemPlacement DGeneralInfoSection = 'DocItemInlined

type DocItemReferenced DGeneralInfoSection

Defined in Michelson.Doc

type DocItemReferenced DGeneralInfoSection = 'False

data DName

Constructors

DName Text SubDoc

Instances

DocItem DName

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]

type DocItemPlacement DName

Defined in Michelson.Doc

type DocItemPlacement DName = 'DocItemInlined

type DocItemReferenced DName

Defined in Michelson.Doc

type DocItemReferenced DName = 'False

data DDescription

Constructors

DDescription Markdown

Instances

DocItem DDescription

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

Defined in Michelson.Doc

type DocItemPlacement DDescription = 'DocItemInlined

type DocItemReferenced DDescription

Defined in Michelson.Doc

type DocItemReferenced DDescription = 'False

data DEntrypointExample

Modify the example value of an entrypoint

Constructors

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

Instances

DocItem DEntrypointExample

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

Defined in Lorentz.Doc

type DocItemPlacement DEntrypointExample = 'DocItemInlined

type DocItemReferenced DEntrypointExample

Defined in Lorentz.Doc

type DocItemReferenced DEntrypointExample = 'False

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

data DGitRevision

Constructors

DGitRevisionKnown DGitRevisionInfo

DGitRevisionUnknown

Instances

DocItem DGitRevision

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

Defined in Michelson.Doc

type DocItemPlacement DGitRevision = 'DocItemInlined

type DocItemReferenced DGitRevision

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

DocItem DComment

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

Defined in Michelson.Doc

type DocItemPlacement DComment = 'DocItemInlined

type DocItemReferenced DComment

Defined in Michelson.Doc

type DocItemReferenced DComment = 'False

data DAnchor

Constructors

DAnchor Anchor

Instances

DocItem DAnchor

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

Defined in Michelson.Doc

type DocItemPlacement DAnchor = 'DocItemInlined

type DocItemReferenced DAnchor

Defined in Michelson.Doc

type DocItemReferenced DAnchor = 'False

data DType where

Constructors

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

Instances

Eq DType

Defined in Michelson.Typed.Haskell.Doc

Methods

(==) :: DType -> DType -> Bool

(/=) :: DType -> DType -> Bool

Ord DType

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

Defined in Michelson.Typed.Haskell.Doc

Methods

showsPrec :: Int -> DType -> ShowS

show :: DType -> String

showList :: [DType] -> ShowS

DocItem DType

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

Defined in Michelson.Typed.Haskell.Doc

type DocItemPlacement DType = 'DocItemInDefinitions

type DocItemReferenced DType

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

docItemSectionRef :: DocItem di => Maybe Markdown

class ContainsDoc a where

Methods

buildDocUnfinalized :: a -> ContractDoc

Instances

ContainsDoc (i :-> o)

Defined in Lorentz.Doc

Methods

buildDocUnfinalized :: (i :-> o) -> ContractDoc

ContainsDoc (Contract cp st)

Defined in Lorentz.Run

Methods

buildDocUnfinalized :: Contract cp st -> ContractDoc

class ContainsDoc a => ContainsUpdateableDoc a where

Methods

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

Instances

ContainsUpdateableDoc (i :-> o)

Defined in Lorentz.Doc

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> (i :-> o) -> i :-> o

ContainsUpdateableDoc (Contract cp st)

Defined in Lorentz.Run

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> Contract cp st -> Contract cp st

data WithFinalizedDoc a

Instances

Monad WithFinalizedDoc

Defined in Michelson.Doc

Methods

(>>=) :: WithFinalizedDoc a -> (a -> WithFinalizedDoc b) -> WithFinalizedDoc b

(>>) :: WithFinalizedDoc a -> WithFinalizedDoc b -> WithFinalizedDoc b

return :: a -> WithFinalizedDoc a

Functor WithFinalizedDoc

Defined in Michelson.Doc

Methods

fmap :: (a -> b) -> WithFinalizedDoc a -> WithFinalizedDoc b

(<$) :: a -> WithFinalizedDoc b -> WithFinalizedDoc a

Applicative WithFinalizedDoc

Defined in 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

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

TypeHasDoc Bool

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

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

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

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

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 MText

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 Operation

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 EpAddress

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 Address

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 ChainId

Defined in 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 KeyHash

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 Mutez

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 PublicKey

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

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

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

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]

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)

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)

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)

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)

TypeHasDoc p => TypeHasDoc (FutureContract p)

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 (TSignature a)

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 a => TypeHasDoc (Packed a)

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 r, IsError (VoidResult r)) => TypeHasDoc (VoidResult r)

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)

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)

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)

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)

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)

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)

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)

TypeHasDoc p => TypeHasDoc (TAddress p)

Defined in Lorentz.Doc

Associated Types

type TypeDocFieldDescriptions (TAddress p) :: FieldDescriptions

Methods

typeDocName :: Proxy (TAddress p) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (TAddress p) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (TAddress p) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (TAddress p)

typeDocMichelsonRep :: TypeDocMichelsonRep (TAddress p)

(KnownHashAlgorithm alg, TypeHasDoc a) => TypeHasDoc (Hash alg a)

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)

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, TypeHasDoc] '[a, r] => TypeHasDoc (Void_ a r)

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)

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)

PolyTypeHasDocC '[a, b, c] => TypeHasDoc (a, b, c)

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)

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)

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)

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)

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)

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

HaveCommonTypeCtor (a :: k) (a :: k)

Defined in Michelson.Typed.Haskell.Doc

HaveCommonTypeCtor ac bc => HaveCommonTypeCtor (ac a :: k2) (bc b :: k4)

Defined in Michelson.Typed.Haskell.Doc

class IsHomomorphic (a :: k)

Instances

IsHomomorphic (a :: k)

Defined in Michelson.Typed.Haskell.Doc

(TypeError ('Text "Type is not homomorphic: " :<>: 'ShowType (a b)) :: Constraint) => IsHomomorphic (a b :: k2)

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

TypeHasDoc p => TypeHasDoc (FutureContract p)

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)

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

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)

TypeHasDoc p => TypeHasDoc (TAddress p)

Associated Types

type TypeDocFieldDescriptions (TAddress p) :: FieldDescriptions

Methods

typeDocName :: Proxy (TAddress p) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (TAddress p) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (TAddress p) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (TAddress p)

typeDocMichelsonRep :: TypeDocMichelsonRep (TAddress p)

ContainsDoc (i :-> o)

Methods

buildDocUnfinalized :: (i :-> o) -> ContractDoc

ContainsUpdateableDoc (i :-> o)

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> (i :-> o) -> i :-> o