KayaDoc.describeFunctionHTML(3kaya)
NAME
KayaDoc::describeFunctionHTML - Describe a function in HTML
SYNOPSIS
ElementTree describeFunctionHTML( ElementTree fun, String(String, Int, EntryType) linkto )
ARGUMENTS
fun A function description retrieved with KayaDoc.findEntry (3kaya)
linkto A function that given a name, an index number (for disambiguation of overloaded functions), and an KayaDoc.EntryType (3kaya) returns
the URL at which documentation for that function / type / module may be
found. The name of a function may include the module it is in (e.g.
KayaDoc::readDoc ) or may not, in which case the current module should
be assumed.
DESCRIPTION
Return a block of HTML 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.describeDataHTML (3kaya) KayaDoc.describeExceptionHTML (3kaya) KayaDoc.describeFunctionMan (3kaya) KayaDoc.findEntry (3kaya) HTMLDocument.appendExisting (3kaya)