Raphael Hertzog <[email protected]> writes:
>> Reference: perlpod(1).
>
> Yes, read that better:
>
> A Pod block starts with any command paragraph, so a "=pod" command is
> usually used just when you want to start a Pod block with an ordinary
> paragraph or a verbatim paragraph. For example:
>
> =item stuff()
Full Specification below.
For the '=pod' the developers write: "...signals to Perl (and Pod
formatters) that a Pod block starts here." Compare to the official
example in "Command Paragraph".
Jari
Command Paragraph
A command paragraph is used for special treatment of whole chunks of
text, usually as
headings or parts of lists.
All command paragraphs (which are typically only one line long) start
with "=", followed by
an identifier, followed by arbitrary text that the command can use
however it pleases.
Currently recognized commands are
=pod
=head1 Heading Text
=head2 Heading Text
=head3 Heading Text
=head4 Heading Text
=over indentlevel
=item stuff
=back
=begin format
=end format
=for format text...
=encoding type
=cut
"=pod"
The "=pod" command by itself doesn't do much of anything, but it
signals to Perl (and Pod
formatters) that a Pod block starts here. A Pod block starts with
any command paragraph,
so a "=pod" command is usually used just when you want to start a
Pod block with an
ordinary paragraph or a verbatim paragraph. For example:
=item stuff()
This function does stuff.
=cut
sub stuff {
...
}
=pod
Remember to check its return value, as in:
stuff() || die "Couldn't do stuff!";
=cut
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
