KayaDoc::describeFunctionMan(3) Describe a function in man page format

SYNOPSIS

String describeFunctionMan( ElementTree fundata, String modname, String authors="" )

ARGUMENTS

fundata A function description retrieved with KayaDoc.findEntry(3kaya)

modname The current module

authors A string in man page format describing the authorship of the function

DESCRIPTION

Return a man page that describes the function.

AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others ([email protected]). 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.describeFunctionHTML(3kaya)

KayaDoc.findEntry(3kaya)