1KayaDoc.htmliseContents(3kaya)Kaya module referencKeayaDoc.htmliseContents(3kaya)
2
3
4

NAME

6       KayaDoc::htmliseContents  -  Convert  the  contents of a (e.g.) <prose>
7       section to HTML
8

SYNOPSIS

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

ARGUMENTS

14       tree A section of API documentation, most usually either a prose , item
15       or example element.
16
17       addto A HTML element to add the documentation to
18
19       linkto A URL generation function that given a  name,  an  index  number
20       (for  disambiguation of overloaded functions), and an KayaDoc.EntryType
21       (3kaya) returns the URL at which documentation for that function / type
22       / module may be found. The name of a function may include the module it
23       is in (e.g.  KayaDoc::readDoc ) or may not, in which case  the  current
24       module should be assumed.
25

DESCRIPTION

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

AUTHORS

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

LICENSE

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

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