---
name: "KayaDoc.moduleSummary"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/KayaDoc.moduleSummary"
---

# KayaDoc.moduleSummary(3kaya)

Get the summary of a module

## NAME

KayaDoc::moduleSummary - Get the summary of a module

## SYNOPSIS

**ElementTree moduleSummary(** *APIDoc doc* **)**

## ARGUMENTS

**doc** API documentation

## DESCRIPTION

Get the summary documentation block for a module. This block will contain a **summary**  element, and then some combination of **prose**  , **example**  and **list**  elements as described in the **XMLDOCS**  specification file.

## 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.