/ 
Dist-Zilla-PluginBundle-Author-GETTY-0.301
River stage one • 1 direct dependent • 1 total dependent
/ Pod::Elemental::Transformer::Author::GETTY

NAME

Pod::Elemental::Transformer::Author::GETTY - Transform custom POD commands to =head2

VERSION

version 0.301

SYNOPSIS

my $xform = Pod::Elemental::Transformer::Author::GETTY->new;
$xform->transform_node($pod_document);

DESCRIPTION

This transformer converts custom POD commands into standard =head2 commands. The commands are left in place (not collected into sections), so documentation stays close to the code it documents.

SUPPORTED COMMANDS

The following commands are transformed to =head2:

  • =attr - for documenting attributes

  • =method - for documenting methods

  • =func - for documenting functions

  • =opt - for documenting CLI options

  • =env - for documenting environment variables

  • =event - for documenting events

  • =hook - for documenting hooks

  • =resource - for documenting resources/features

  • =seealso - for documenting related modules

  • =example - for documenting examples

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-dist-zilla-pluginbundle-author-getty/issues.

IRC

You can reach Getty on irc.perl.org for questions and support.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <torsten@raudssus.de> https://raudss.us/

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by Torsten Raudssus <torsten@raudssus.de> https://raudss.us/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.