Scroll to navigation

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

NAME

KayaDoc::extractSummary - Find the summary component of a documentation block

SYNOPSIS

Maybe<ElementTree> extractSummary( ElementTree part )

ARGUMENTS

part A documentation block extracted from API documentation

DESCRIPTION

Find the summary component of a documentation block, if possible.

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.findEntry (3kaya)
KayaDoc.moduleSummary (3kaya)
August 2014 Kaya