WireApiDocs::getGroupSummaries()

Get group summaries from a class phpdoc

Parses [group] tags from the class-level phpdoc block. Returns an associative array keyed by group name, values are the summary strings.

Example phpdoc tag: access Access-control related methods/properties

Usage

$array = $wireApiDocs->getGroupSummaries(string $class);

Arguments

NameType(s)Description
$classstring

Class name (with or without ProcessWire namespace)

Return value

array

e.g. ['access' => 'Access-control related methods/properties', ...]

WireApiDocs methods and properties

API reference based on ProcessWire core version 3.0.267