Documentation for method parse-definition-header assembled from the following types:

class Documentable::Primary

From Documentable::Primary

(Documentable::Primary) method parse-definition-header

Defined as

method parse-definition-header(Pod::Heading :$heading --> Hash)

This method takes a Pod::Heading element and returns its metadata in a Hash object.

This returned Hash follow this format:

%(
    name       => ...
    kind       => ...
    subkinds   => ...
    categories => ...
)

For this to happen, the Pod::Heading object must verify one of this two conditions:

• Must follow the format:

  =headn X<foo|bar> 

  Where n is a number from 1 to 6. In this case, subkinds and categories keys are set to the meta part of X<>, if possible. kind key is set to Kind::Syntax and name will be set to the second element of the meta part, or to the first one if there's only one.

• Returns a non-empty match with Documentable::Heading::Grammar.

  That means, if we have the following heading:

  =head2 The infix foo 

  Then the string The infix foo will be passed to the grammar, which will use Documentable::Heading::Actions to set the returned Hash.