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

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 - base class for formatters

SYNOPSIS ^

None.

DESCRIPTION ^

This is a base class for formatters. See Module::Changes::Formatter::YAML and Module::Changes::Formatter::Free for examples.

METHODS ^

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

format

An abstract method that is used to format a changes object. Individual formatters need to override and implement this method.

format_to_file
    $formatter->format_to_file($changes, 'Changes');

Takes a changes object and a filename and uses format() to format the changes object, then writes the resulting string to the indicated file.

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: