Thomas Klausner > Pod-Strip > Pod::Strip

Download:
Pod-Strip-1.02.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.02   Source  

NAME ^

Pod::Strip - Remove POD from Perl code

SYNOPSIS ^

    use Pod::Strip;

    my $p=Pod::Strip->new;              # create parser
    my $podless;                        # set output string
    $p->output_string(\$podless);       # see Pod::Simple
    $p->parse_string_document($code);   # or some other parsing method
                                        #    from Pod::Simple
    # $podless will now contain code without any POD

DESCRIPTION ^

Pod::Strip is a subclass of Pod::Simple that strips all POD from Perl Code.

METHODS ^

All methods besides those listed here are inherited from Pod::Simple

new

Generate a new parser object.

replace_with_comments

Call this method with a true argument to replace POD with comments (looking like "# stripped POD") instead of stripping it.

This has the effect that line numbers get reported correctly in error messages etc.

AUTHOR ^

Thomas Klausner, <domm@cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-pod-strip@rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT & LICENSE ^

Copyright 2004, 2005, 2006 Thomas Klausner, All Rights Reserved.

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

syntax highlighting: