Scroll to navigation

KayaDoc.readDoc(3kaya) Kaya module reference KayaDoc.readDoc(3kaya)

NAME

KayaDoc::readDoc - Read an -xmldocs .xml file

SYNOPSIS

APIDoc readDoc( String filename )

ARGUMENTS

filename The filename of the documentation

DESCRIPTION

Reads a file generated with -xmldocs into an ElementTreeData.ElementTree (3kaya)
This is then used by the other functions in this module.

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.

RELATED

KayaDoc.readString (3kaya)
August 2014 Kaya