SpadDoc

sdoc.spad line 1 [edit on github]

This package provides simple Spad documentation for the interpreter and the MCP server.

constructorDocumentation: Symbol -> Void

constructorDocumentation(term) displays the documentation of the constructor term.

getConstructorDocumentation: Symbol -> String

getConstructorDocumentation(term) returns the cleaned documentation of constructor term.

getOperationDocumentation: Symbol -> List Record(origin: String, signature: String, doc: String)

getOperationDocumentation(op) returns a list of records containing the origin constructor, signature, and documentation for operation op.

listCategories: Symbol -> List Symbol

listCategories(cat) returns a list of the categories matching the categories cat.

listConstructors: Symbol -> Record(categories: List Symbol, domains: List Symbol, packages: List Symbol)

listConstructors(const) returns a list of the categories, domains, and packages that the constructor const belongs to. For example:

listConstructors('AbelianMonoidRing)
listConstructors("Int*")

listDomains: Symbol -> List Symbol

listDomains(dom) returns a list of the domains matching the domains dom.

listPackages: Symbol -> List Symbol

listPackages(pack) returns a list of the packages matching the packages pack.

operationDocumentation: Symbol -> Void

operationDocumentation(op) displays the documentation of the operation op.