Module::Changes::Formatter - base class for formatters


Module-Changes documentation  | view source Contained in the Module-Changes distribution.

Index


NAME

Top

Module::Changes::Formatter - base class for formatters

SYNOPSIS

Top

None.

DESCRIPTION

Top

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

METHODS

Top

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

Top

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

BUGS AND LIMITATIONS

Top

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

Top

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

Top

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

Top

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

COPYRIGHT AND LICENSE

Top


Module-Changes documentation  | view source Contained in the Module-Changes distribution.