Joshua Hoblitt > Pod-Tidy-0.10 > Pod::Wrap::Pretty

Download:
Pod-Tidy-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  2
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Pod::Wrap::Pretty - reformat Pod to be nicely line wrapped

SYNOPSIS ^

    use Pod::Wrap::Pretty;

    my $w = new Pod::Wrap::Pretty;

    $w->parse_from_filehandle($fh);
    $w->parse_from_file($filename);

DESCRIPTION ^

This is a Pod::Wrap subclass, which is in turn a Pod::Parser subclass. Please see the Pods of those modules for further API documentation.

This module performs the exact same functionality as Pod::Wrap except that all pre-existing newlines are removed prior to line breaking and trailing whitespace is removed from the end of paragraphs. This provides nicely formatted paragraphs similar to vim's gq command.

DEVELOPER NOTES ^

These Pod::Wrap subroutines have been overridden.

CREDITS ^

Yuval Kogman <nothingmuch@woobling.org> author of Pod::Wrap

SUPPORT ^

Please contact the author directly via e-mail.

AUTHOR ^

Joshua Hoblitt <jhoblitt@cpan.org>

COPYRIGHT ^

Copyright (c) 2005 Joshua Hoblitt. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the licenses can be found in the LICENSE file included with this module, or in perlartistic and perlgpl Pods as supplied with Perl 5.8.1 and later.

SEE ALSO ^

Pod::Wrap, Pod::Parser

syntax highlighting: