1KayaDoc.maniseContents(3kaya)Kaya module referenceKayaDoc.maniseContents(3kaya)
2
3
4

NAME

6       KayaDoc::maniseContents - Convert the contents of a (e.g.) <prose> sec‐
7       tion to man page format
8

SYNOPSIS

10       String maniseContents( ElementTree summary, Bool  preformatted,  String
11       manstr, String modname )
12

ARGUMENTS

14       summary  A  section of API documentation, most usually either a prose ,
15       item or example element.
16
17       preformatted Is the text in this section preformatted? This should gen‐
18       erally be set to true for processing example elements, and false other‐
19       wise.
20
21       manstr This String will be prepended to the output
22
23       modname The name of the current module
24

DESCRIPTION

26       Convert a section of API documentation to man page format. This may  be
27       useful for working with summary documentation.
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.describeDataMan (3kaya)
41       KayaDoc.describeExceptionMan (3kaya)
42       KayaDoc.describeFunctionMan (3kaya)
43
44
45
46Kaya                             December 2010   KayaDoc.maniseContents(3kaya)
Impressum