KayaDoc.maniseContents(3kaya)
NAME
KayaDoc::maniseContents - Convert the contents of a (e.g.) <prose> section to man page format
SYNOPSIS
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
DESCRIPTION
Convert a section of API documentation to man page format. This may be
useful for working with summary documentation.
AUTHORS
Kaya standard library by Edwin Brady, Chris Morris and others
(kaya@kayalang.org). For further information see http://kayalang.org/
LICENSE
The Kaya standard library is free software; you can redistribute it
and/or modify it under the terms of the GNU Lesser General Public
License (version 2.1 or any later version) as published by the Free
Software Foundation.
RELATED
- KayaDoc.describeDataMan (3kaya) KayaDoc.describeExceptionMan (3kaya) KayaDoc.describeFunctionMan (3kaya)