SpadDoc

sdoc.spad line 1 [edit on github]

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

constructorDocumentation: Symbol -> Void

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

getConstructorDocumentation: Symbol -> String

getConstructorDocumentation(term) returns the documentation of the constructor term as a string.

getOperationDocumentation: Symbol -> String

getOperationDocumentation(op) returns the documentation of the operation op as a string.

listCategories: Symbol -> List Symbol

listCategories(cat) returns a list of the categories matching the categories cat. Convenience and temporary function.

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: example{listConstructors(‘AbelianMonoidRing)} example{listConstructors(“Int*”)}

listDomains: Symbol -> List Symbol

listDomains(dom) returns a list of the domains matching the domains dom. Convenience and temporary function.

listPackages: Symbol -> List Symbol

listPackages(pack) returns a list of the packages matching the packages pack. Convenience and temporary function.

operationDocumentation: Symbol -> Void

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