Scroll to navigation

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

NAME

KayaDoc::findEntry - Find a documentation entry

SYNOPSIS

ElementTree findEntry( APIDoc doc, EntryLocation entry )

ARGUMENTS

doc API documentation
entry An KayaDoc.EntryLocation (3kaya) describing the API component to be retrieved.

DESCRIPTION

Finds a documentation entry for a function, data type or exception in a module. An Exception will be thrown if the entry does not exist.

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.EntryLocation (3kaya)
KayaDoc.extractSummary (3kaya)
October 2012 Kaya