1KayaDoc.toHTML(3kaya)        Kaya module reference       KayaDoc.toHTML(3kaya)
2
3
4

NAME

6       KayaDoc::toHTML - Convert API documentation to HTML
7

SYNOPSIS

9       Void  toHTML( ElementTree div, ElementTree comment, String(String, Int,
10       EntryType) linkto )
11

ARGUMENTS

13       div The HTML element to insert documentation into
14
15       comment The API documentation for a function, data type or exception
16
17       linkto A URL generation function that given a  name,  an  index  number
18       (for  disambiguation of overloaded functions), and an KayaDoc.EntryType
19       (3kaya) returns the URL at which documentation for that function / type
20       / module may be found. The name of a function may include the module it
21       is in (e.g.  KayaDoc::readDoc ) or may not, in which case  the  current
22       module should be assumed.
23

DESCRIPTION

25       Converts  API  documentation  to HTML. This function rarely needs to be
26       called directly except when using KayaDoc.moduleSummary (3kaya)
27
28

AUTHORS

30       Kaya  standard  library  by  Edwin  Brady,  Chris  Morris  and   others
31       (kaya@kayalang.org). For further information see http://kayalang.org/
32

LICENSE

34       The  Kaya  standard  library  is free software; you can redistribute it
35       and/or modify it under the terms  of  the  GNU  Lesser  General  Public
36       License  (version  2.1  or  any later version) as published by the Free
37       Software Foundation.
38

40       KayaDoc.describeDataHTML (3kaya)
41       KayaDoc.describeExceptionHTML (3kaya)
42       KayaDoc.describeFunctionHTML (3kaya)
43
44
45
46Kaya                             December 2010           KayaDoc.toHTML(3kaya)
Impressum