Linux Certif

Toute la documentation sur la certification Linux LPI

KayaDoc.3kaya

NAME

KayaDoc - Kaya API documentation generator

DESCRIPTION

This module contains functions to convert documentation files created with kayac's -xmldocs option into HTML or man page format. The source of the kayadoc2man program in the tools directory of the Kaya distribution may be useful for examples of use. It also provides an API to examine the documentation for writing other formats - see the ElementTree(3kaya) module for details of processing the XML representation.

HTML documentation produced with this module may be seen on the Kaya website , and man pages are installed in prefix/man/man3/*.3kaya.gz by the Kaya installation process.

 // generate HTML document for a particular function
 doc = readDoc("MyModule.xml");
 entry = findEntry(doc,EntryLocation("myFunction",0,EntryFunction));
 appendExisting(html.body,describeFunctionHTML(entry));
 
 // get a list of all the data types in a module
 // and summarise them in HTML
 doc = readDoc("MyModule.xml");
 ds = listDataTypes(doc);
 for d in ds {
     htmliseContents(d.summary,html.body,linkFn);
 }
 
 // get the short summary for a module in man page format
 doc = readDoc("MyModule.xml");
 summ = extractSummary(moduleSummary(doc));
 manstr = manSummary(summ)

A specification for the -xmldocs format can be found in the XMLDOCS file.

TYPE SYNONYMS

APIDoc = ElementTree

DATA TYPES

KayaDoc.Constructor(3kaya)

KayaDoc.DataSummary(3kaya)

KayaDoc.EntryLocation(3kaya)

KayaDoc.EntryType(3kaya)

KayaDoc.ExceptionSummary(3kaya)

KayaDoc.FunctionSummary(3kaya)

KayaDoc.TypeSynonym(3kaya)

EXCEPTIONS

KayaDoc.ModuleContext(3kaya)

KayaDoc.NoSuchEntry(3kaya)

FUNCTIONS

KayaDoc.describeDataHTML(3kaya)

KayaDoc.describeDataMan(3kaya)

KayaDoc.describeExceptionHTML(3kaya)

KayaDoc.describeExceptionMan(3kaya)

KayaDoc.describeFunctionHTML(3kaya)

KayaDoc.describeFunctionMan(3kaya)

KayaDoc.extractSummary(3kaya)

KayaDoc.findEntry(3kaya)

KayaDoc.htmliseContents(3kaya)

KayaDoc.listDataTypes(3kaya)

KayaDoc.listExceptions(3kaya)

KayaDoc.listFunctions(3kaya)

KayaDoc.listTypes(3kaya)

KayaDoc.manFilename(3kaya)

KayaDoc.manSummary(3kaya)

KayaDoc.manTime(3kaya)

KayaDoc.maniseContents(3kaya)

KayaDoc.moduleSummary(3kaya)

KayaDoc.readDoc(3kaya)

KayaDoc.readString(3kaya)

KayaDoc.toHTML(3kaya)

KayaDoc.toMan(3kaya)

AUTHORS

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

LICENSE

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