morley-1.20.0: Developer tools for the Michelson Language
Safe HaskellSafe-Inferred
LanguageHaskell2010

Morley.Michelson.Typed.Doc

Description

Extracting documentation from instructions set.

Synopsis

Documentation

cutInstrNonDoc :: (forall i o. Instr i o -> Instr i o) -> Instr inp out -> Instr s s Source #

Leave only instructions related to documentation.

Generated documentation for resulting instruction remains the same, but semantics of instruction itself gets lost. We have to pass optimizer here as an argument to avoid cyclic dependencies.

docInstr :: DocItem di => di -> Instr s s Source #

Put a document item.

Orphan instances

ContainsDoc (Contract cp st) Source # 
Instance details

Methods

buildDocUnfinalized :: Contract cp st -> ContractDoc Source #

ContainsDoc (ContractCode inp out) Source # 
Instance details

Methods

buildDocUnfinalized :: ContractCode inp out -> ContractDoc Source #

ContainsDoc (Instr inp out) Source # 
Instance details

Methods

buildDocUnfinalized :: Instr inp out -> ContractDoc Source #

ContainsUpdateableDoc (Contract cp st) Source # 
Instance details

Methods

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

ContainsUpdateableDoc (ContractCode inp out) Source # 
Instance details

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> ContractCode inp out -> ContractCode inp out Source #

ContainsUpdateableDoc (Instr inp out) Source # 
Instance details

Methods

modifyDocEntirely :: (SomeDocItem -> SomeDocItem) -> Instr inp out -> Instr inp out Source #