SYNOPSIS

Void htmliseContents( ElementTree tree, ElementTree addto, String(String, Int, EntryType) linkto )

ARGUMENTS

tree A section of API documentation, most usually either a prose , item or example element.

addto A HTML element to add the documentation to

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

Convert a section of API documentation to HTML. This may be useful for working with summary documentation.

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.describeDataHTML (3kaya)

KayaDoc.describeExceptionHTML (3kaya)

KayaDoc.describeFunctionHTML (3kaya)