Kaya 0.5.2 reference for KayaDoc::maniseContents

String maniseContents(ElementTree summary, Bool preformatted, String manstr, String modname)

Arguments

• summary: A section of API documentation, most usually either a prose, item or example element.
• preformatted: Is the text in this section preformatted? This should generally be set to true for processing example elements, and false otherwise.
• manstr: This String will be prepended to the output
• modname: The name of the current module

Usage

Convert a section of API documentation to man page format. This may be useful for working with summary documentation.

Related

• describeDataMan
• describeExceptionMan
• describeFunctionMan