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

NAME

6       KayaDoc - Kaya API documentation generator
7

DESCRIPTION

9       This  module  contains functions to convert documentation files created
10       with kayac's -xmldocs option into HTML or man page format.  The  source
11       of the kayadoc2man program in the tools directory of the Kaya distribu‐
12       tion may be useful for examples of use. It  also  provides  an  API  to
13       examine  the documentation for writing other formats - see the Element‐
14       Tree(3kaya) module for details of processing the XML representation.
15
16       HTML documentation produced with this module may be seen  on  the  Kaya
17       website   ⟨http://kayalang.org/library/latest⟩  ,  and  man  pages  are
18       installed  in  prefix/man/man3/*.3kaya.gz  by  the  Kaya   installation
19       process.
20
21
22    // generate HTML document for a particular function
23    doc = readDoc("MyModule.xml");
24    entry = findEntry(doc,EntryLocation("myFunction",0,EntryFunction));
25    appendExisting(html.body,describeFunctionHTML(entry));
26
27    // get a list of all the data types in a module
28    // and summarise them in HTML
29    doc = readDoc("MyModule.xml");
30    ds = listDataTypes(doc);
31    for d in ds {
32        htmliseContents(d.summary,html.body,linkFn);
33    }
34
35    // get the short summary for a module in man page format
36    doc = readDoc("MyModule.xml");
37    summ = extractSummary(moduleSummary(doc));
38    manstr = manSummary(summ)
39
40       A  specification  for  the  -xmldocs format can be found in the XMLDOCS
41       file.
42

TYPE SYNONYMS

44       APIDoc = ElementTree

DATA TYPES

46       KayaDoc.Constructor (3kaya)
47       KayaDoc.DataSummary (3kaya)
48       KayaDoc.EntryLocation (3kaya)
49       KayaDoc.EntryType (3kaya)
50       KayaDoc.ExceptionSummary (3kaya)
51       KayaDoc.FunctionSummary (3kaya)
52       KayaDoc.TypeSynonym (3kaya)

EXCEPTIONS

54       KayaDoc.ModuleContext (3kaya)
55       KayaDoc.NoSuchEntry (3kaya)

FUNCTIONS

57       KayaDoc.describeDataHTML (3kaya)
58       KayaDoc.describeDataMan (3kaya)
59       KayaDoc.describeExceptionHTML (3kaya)
60       KayaDoc.describeExceptionMan (3kaya)
61       KayaDoc.describeFunctionHTML (3kaya)
62       KayaDoc.describeFunctionMan (3kaya)
63       KayaDoc.extractSummary (3kaya)
64       KayaDoc.findEntry (3kaya)
65       KayaDoc.htmliseContents (3kaya)
66       KayaDoc.listDataTypes (3kaya)
67       KayaDoc.listExceptions (3kaya)
68       KayaDoc.listFunctions (3kaya)
69       KayaDoc.listTypes (3kaya)
70       KayaDoc.manFilename (3kaya)
71       KayaDoc.manSummary (3kaya)
72       KayaDoc.manTime (3kaya)
73       KayaDoc.maniseContents (3kaya)
74       KayaDoc.moduleSummary (3kaya)
75       KayaDoc.readDoc (3kaya)
76       KayaDoc.readString (3kaya)
77       KayaDoc.toHTML (3kaya)
78       KayaDoc.toMan (3kaya)

AUTHORS

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

LICENSE

83       The  Kaya  standard  library  is free software; you can redistribute it
84       and/or modify it under the terms  of  the  GNU  Lesser  General  Public
85       License  (version  2.1  or  any later version) as published by the Free
86       Software Foundation.
87
88
89
90Kaya                             December 2010                  KayaDoc(3kaya)
Impressum