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

NAME

6       KayaDoc::toMan - Convert API documentation to man page format
7

SYNOPSIS

9       String toMan( ElementTree div, String modname, String authors )
10

ARGUMENTS

12       div The API documentation for a function, data type or exception
13
14       modname The current module
15
16       authors  A  string  in man page format describing the authorship of the
17       data type
18

DESCRIPTION

20       Converts API documentation to man page  format.  This  function  rarely
21       needs  to  be  called  directly except when using KayaDoc.moduleSummary
22       (3kaya)
23
24

AUTHORS

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

LICENSE

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

36       KayaDoc.describeDataMan (3kaya)
37       KayaDoc.describeExceptionMan (3kaya)
38       KayaDoc.describeFunctionMan (3kaya)
39
40
41
42Kaya                             December 2010            KayaDoc.toMan(3kaya)
Impressum