view release on metacpan or  search on metacpan

lib/Pod/Weaver/PluginBundle/Author/GETTY.pm  view on Meta::CPAN

C<-SingleEncoding> - ensures consistent character encoding

=item *

Standard sections: NAME, VERSION, SYNOPSIS, DESCRIPTION, OVERVIEW, STABILITY

=item *

C<-Transformer> with L<Pod::Elemental::Transformer::List> - transforms C<=for :list> regions

=item *

C<-Transformer> with L<Pod::Elemental::Transformer::Author::GETTY> - transforms custom commands to C<=head2>

=item *

Standard boilerplate: SUPPORT, CONTRIBUTING, AUTHORS, LICENSE

=back

=head1 COMMANDS

This bundle provides custom documentation commands that are shortcuts for
C<=head2>. Unlike traditional Pod::Weaver collectors, these commands stay
B<exactly where you put them> in your source file - they are not collected
into separate sections. This keeps documentation close to the code it describes.

=head2 =attr

Documents object attributes. Place directly after C<has> declarations.

  has name => ( is => 'ro' );

  =attr name

  The user's name. Required.

=head2 =method

Documents object methods. Place directly after the C<sub> definition.

  =method process

    my $result = $obj->process($data);

  Process the input data and return a result.

=head2 =func

Documents exported functions. Place near the function definition.

  =func parse_config

    my $config = parse_config($filename);

  Parse a configuration file and return a hashref.

=head2 =resource

Documents available resources, features, or API endpoints.

  =resource servers

  Cloud servers (create, delete, power on/off)

=head2 =opt

Documents command-line options for CLI tools.

  =opt --verbose

  Enable verbose output.

=head2 =env

Documents environment variables.

  =env API_KEY

  API authentication key. Required for API access.

=head2 =event

Documents events that can be emitted or subscribed to.

  =event user.created

  Emitted when a new user is created.

=head2 =hook

Documents hooks or callbacks.

  =hook before_save

  Called before saving an object to the database.

=head2 =example

Documents usage examples.

  =example Basic Usage

    my $client = MyApp::Client->new;
    $client->connect;

=head2 =seealso

Documents related modules or links.

  =seealso L<Some::Other::Module>

  Related functionality for X.

=head1 STANDARD SECTIONS

This bundle automatically generates the following standard sections:

=over 4