Marcel Grünauer > Module-Changes-0.05 > Module::Changes::Formatter::Free

Download:
Module-Changes-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Module::Changes::Formatter::Free - format a Changes object in freeform

SYNOPSIS ^

    use Module::Changes;
    my $formatter = Module::Changes->make_object_for_type('formatter_free',
        indent => 4
    );
    $formatter->format($changes);

DESCRIPTION ^

This class can format a Changes object in a kind of freeform format. This makes the Changes file look more or less like traditional Changes files do.

METHODS ^

This class inherits all methods from Module::Changes::Formatter.

indent
    $formatter->indent(4);
    my $indent = $formatter->indent;

Set or get the indent used to format individual changes and tags lines. The default is an indent of 4.

format_line
    print $formatter->format_line('Added foobar()');

Takes a changes string and formats it to look like they do in traditional Changes files, with an indent and a leading dash. The resulting string is returned.

Long change strings, spanning multiple lines, aren't handled gracefully yet.

This method is used internally; most likely you will not need to use it.

format_release
    print $formatter->format_release($release);

Takes a release object and formats it, then returns the result string.

This method is used internally; most likely you will not need to use it.

format
    print $formatter->format($changes);

Takes a changes object and formats it, then returns the result string.

TAGS ^

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the modulechanges tag.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-module-changes@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007 by Marcel Grünauer

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

syntax highlighting: