Rules / Types, classes & roles / domain-specific

Pod::Block Reference

Block in a Pod document

What it is #

Position in the hierarchy #

Inherits from—
Does—
Inherited byPod::Block::Code, Pod::Block::Comment, Pod::Block::Declarator, Pod::Block::Named, Pod::Block::Para, Pod::Block::Table, Pod::FormattingCode, Pod::Heading, Pod::Item, Pod::Defn

Routines #

Signatures are reproduced from the documentation, including their declared return types. A routine listed here is part of the type's published interface; whether Raku++ implements it is a separate question, answered by the examples below.

method contents #

method contents(--> Positional:D)

Returns Positional:D.

Returns a list of contents of this block.

method config #

method config(--> Map:D)

Returns Map:D.

Returns a hash of configs.

Examples, run three ways #

Every example below comes from the official documentation, together with the output that documentation asserts. Each was then executed by Rakudo and by Raku++ when this page was built. Where the three agree, one result is shown; where they do not, all three are — because which of them is wrong is exactly the information worth having.

11 no-output

class Pod::Block { }

Not executed: the documentation states no expected output for this example.

Class                     Used for
=====                     ========
Pod::Block::Para          paragraphs

Not executed: the documentation states no expected output for this example.

Pod::Block::Named         named blocks

Not executed: the documentation states no expected output for this example.

Pod::Block::Declarator    declarator blocks

Not executed: the documentation states no expected output for this example.

Pod::Block::Code          code blocks

Not executed: the documentation states no expected output for this example.

Pod::Block::Comment       comments

Not executed: the documentation states no expected output for this example.

Pod::Block::Table         =begin/end table
                          tabular data

Not executed: the documentation states no expected output for this example.

Pod::Heading              =head1 etc. headings

Not executed: the documentation states no expected output for this example.

Pod::Item                 list items

Not executed: the documentation states no expected output for this example.

Pod::Defn                 definition lists

Not executed: the documentation states no expected output for this example.

Pod::FormattingCode       formatting codes

Not executed: the documentation states no expected output for this example.