.\" This man page is automatically generated using .\" kayadoc2man from the Kaya development tools and the -xmldocs compile .\" option. Editing it directly is not encouraged. .\" It is under the same license as the source .k file that it was .\" generated from. .TH "KayaDoc.maniseContents" "3kaya" "August 2014" "Kaya" "Kaya module reference" .SH "NAME" KayaDoc::maniseContents \- Convert the contents of a (e.g.) section to man page format .SH "SYNOPSIS" .B String maniseContents( \fIElementTree summary, Bool preformatted, String manstr, String modname\fP .B ")" .SH "ARGUMENTS" .PP .B "summary" A section of API documentation, most usually either a \fBprose \fP , \fBitem \fP or \fBexample \fP element. .PP .B "preformatted" Is the text in this section preformatted? This should generally be set to true for processing \fBexample \fP elements, and false otherwise. .PP .B "manstr" This String will be prepended to the output .PP .B "modname" The name of the current module .SH "DESCRIPTION" .PP Convert a section of API documentation to man page format. This may be useful for working with summary documentation. .SH "AUTHORS" Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/ .SH 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. .SH "RELATED" .PD 0 .PP .B "KayaDoc.describeDataMan"(3kaya) .PP .B "KayaDoc.describeExceptionMan"(3kaya) .PP .B "KayaDoc.describeFunctionMan"(3kaya) .PD 0.4v