NAME¶
KayaDoc::toHTML - Convert API documentation to HTML
SYNOPSIS¶
Void toHTML( ElementTree div, ElementTree comment, String(String, Int,
EntryType) linkto )
ARGUMENTS¶
div The HTML element to insert documentation into
comment The API documentation for a function, data type or exception
linkto A URL generation 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¶
Converts API documentation to HTML. 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.
KayaDoc.describeDataHTML (3kaya)
KayaDoc.describeExceptionHTML (3kaya)
KayaDoc.describeFunctionHTML (3kaya)