Scroll to navigation

KayaDoc.describeFunctionMan(3kaya) Kaya module reference KayaDoc.describeFunctionMan(3kaya)

NAME

KayaDoc::describeFunctionMan - 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 (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.describeFunctionHTML (3kaya)
KayaDoc.findEntry (3kaya)
August 2014 Kaya