Scroll to navigation

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

NAME

KayaDoc::toMan - Convert API documentation to man page format

SYNOPSIS

String toMan( ElementTree div, String modname, String authors )

ARGUMENTS

div The API documentation for a function, data type or exception
modname The current module
authors A string in man page format describing the authorship of the data type

DESCRIPTION

Converts API documentation to man page format. This function rarely needs to be called directly except when using KayaDoc.moduleSummary (3kaya)

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)
August 2014 Kaya