Changeset 16489

Show
Ignore:
Timestamp:
07/25/08 23:09:47 (5 years ago)
Author:
hanekomu
Message:

continued to update distribution to standard style

Location:
lang/perl/Module-Changes/trunk
Files:
16 modified

Legend:

Unmodified
Added
Removed

  • lang/perl/Module-Changes/trunk/Changes

    r16354 r16489  
    11Revision history for Perl extension Module-Changes 
     2 
     30.07  Thu Jul 25 15:27:43 CEST 2008 (Marcel Gruenauer <marcel@cpan.org>) 
     4     - Changed dist style and Changes back to standard. People didn't like it - 
     5       the nail that sticks out gets hammered down. 
     6     - Added standard test files; this will also help with CPANTS. 
    27 
    380.06  Thu, 29 May 2008 12:05:55 -0000 (Marcel Gruenauer <marcel@cpan.org>) 

  • lang/perl/Module-Changes/trunk/MANIFEST

    r16354 r16489  
    1212inc/Module/Install/Makefile.pm 
    1313inc/Module/Install/Metadata.pm 
    14 inc/Module/Install/StandardTests.pm 
    15 inc/Module/Install/Template.pm 
    1614inc/Module/Install/Win32.pm 
    1715inc/Module/Install/WriteAll.pm 
    … …  
    1917inc/Test/Differences.pm 
    2018inc/Test/More.pm 
    21 inc/UNIVERSAL/require.pm 
    2219lib/Module/Changes.pm 
    2320lib/Module/Changes/Base.pm 

  • lang/perl/Module-Changes/trunk/MANIFEST.SKIP

    r9784 r16489  
    1010^Build$ 
    1111^blib/ 
     12^pm_to_blib/ 
    1213^_build/ 
    1314^MakeMaker-\d 
    … …  
    2728\.old$ 
    2829\.swp$ 
     30\.tar$ 
     31\.tar\.gz$ 
    2932^#.*#$ 
    3033^\.# 

  • lang/perl/Module-Changes/trunk/Makefile.PL

    r9784 r16489  
    1818requires 'YAML'; 
    1919 
    20 build_requires 'Test::Differences'; 
    21 build_requires 'Test::More' => '0.70'; 
     20recommends 'Test::Pod'; 
     21recommends 'Test::Pod::Coverage'; 
    2222 
    23 process_templates( 
    24     first_year => 2007, 
    25     rest_from  => "$ENV{HOME}/.mitlib/standard_pod", 
    26     start_tag  => '{%', 
    27     end_tag    => '%}', 
    28 ); 
     23test_requires 'Test::Differences'; 
     24test_requires 'Test::More' => '0.70'; 
     25test_requires 'Test::Compile'; 
    2926 
    30 use_standard_tests(without => 'pod_coverage'); 
    3127auto_install; 
    3228auto_include; 

  • lang/perl/Module-Changes/trunk/bin/changes

    r9784 r16489  
    284284=back 
    285285 
     286=head1 TAGS 
     287 
     288If you talk about this module in blogs, on del.icio.us or anywhere else, 
     289please use the C<modulechanges> tag. 
     290 
     291=head1 BUGS AND LIMITATIONS 
     292 
     293No bugs have been reported. 
     294 
     295Please report any bugs or feature requests to 
     296C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     297L<http://rt.cpan.org>. 
     298 
     299=head1 INSTALLATION 
     300 
     301See perlmodinstall for information and options on installing Perl modules. 
     302 
     303=head1 AVAILABILITY 
     304 
     305The latest version of this module is available from the Comprehensive Perl 
     306Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     307site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     308 
     309=head1 AUTHOR 
     310 
     311Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     312 
     313=head1 COPYRIGHT AND LICENSE 
     314 
     315Copyright 2007 by Marcel GrE<uuml>nauer 
     316 
     317This library is free software; you can redistribute it and/or modify 
     318it under the same terms as Perl itself. 
     319 
    286320=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes.pm

    r9784 r16489  
    2727 
    2828__END__ 
    29  
    30 {% USE p = PodGenerated %} 
    3129 
    3230=head1 NAME 
    … …  
    136134Integrity check with regard to version numbers and timestamps. 
    137135 
    138 {% PROCESS standard_pod %} 
     136=head1 TAGS 
     137 
     138If you talk about this module in blogs, on del.icio.us or anywhere else, 
     139please use the C<modulechanges> tag. 
     140 
     141=head1 BUGS AND LIMITATIONS 
     142 
     143No bugs have been reported. 
     144 
     145Please report any bugs or feature requests to 
     146C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     147L<http://rt.cpan.org>. 
     148 
     149=head1 INSTALLATION 
     150 
     151See perlmodinstall for information and options on installing Perl modules. 
     152 
     153=head1 AVAILABILITY 
     154 
     155The latest version of this module is available from the Comprehensive Perl 
     156Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     157site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     158 
     159=head1 AUTHOR 
     160 
     161Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     162 
     163=head1 COPYRIGHT AND LICENSE 
     164 
     165Copyright 2007 by Marcel GrE<uuml>nauer 
     166 
     167This library is free software; you can redistribute it and/or modify 
     168it under the same terms as Perl itself. 
    139169 
    140170=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Base.pm

    r9784 r16489  
    1818__END__ 
    1919 
    20 {% USE p = PodGenerated %} 
    21  
    2220=head1 NAME 
    2321 
    … …  
    3634=over 4 
    3735 
    38 {% p.write_methods %} 
     36=item new 
     37 
     38A constructor per L<Class::Accessor::Constructor>. 
    3939 
    4040=back 
    4141 
    42 {% p.write_inheritance %} 
     42=head1 TAGS 
    4343 
    44 {% PROCESS standard_pod %} 
     44If you talk about this module in blogs, on del.icio.us or anywhere else, 
     45please use the C<modulechanges> tag. 
     46 
     47=head1 BUGS AND LIMITATIONS 
     48 
     49No bugs have been reported. 
     50 
     51Please report any bugs or feature requests to 
     52C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     53L<http://rt.cpan.org>. 
     54 
     55=head1 INSTALLATION 
     56 
     57See perlmodinstall for information and options on installing Perl modules. 
     58 
     59=head1 AVAILABILITY 
     60 
     61The latest version of this module is available from the Comprehensive Perl 
     62Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     63site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     64 
     65=head1 AUTHOR 
     66 
     67Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     68 
     69=head1 COPYRIGHT AND LICENSE 
     70 
     71Copyright 2007 by Marcel GrE<uuml>nauer 
     72 
     73This library is free software; you can redistribute it and/or modify 
     74it under the same terms as Perl itself. 
    4575 
    4676=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Entire.pm

    r9784 r16489  
    6868__END__ 
    6969 
    70 {% USE p = PodGenerated %} 
    71  
    7270=head1 NAME 
    7371 
    … …  
    8987=head1 METHODS 
    9088 
     89This class inherits all methods from L<Module::Changes::Base>. 
     90 
    9191=over 4 
    9292 
    93 {% p.write_methods %} 
     93=item name 
     94 
     95    $changes->name('Foo-Bar'); 
     96    my $name = $changes->name; 
     97 
     98Set or get the overall distribution name of the Changes file. 
     99 
     100=item releases 
     101 
     102    $changes->releases_unshift($release); 
     103    for my $release ($changes->releases) { ... } 
     104 
     105This is an array accessor giving access to all the releases contained in the 
     106Changes file. See L<Class::Accessor::Complex>'s C<mk_array_accessors()> for 
     107which methods are available. 
    94108 
    95109=item newest_release 
    … …  
    156170=back 
    157171 
    158 {% p.write_inheritance %} 
    159  
    160 {% PROCESS standard_pod %} 
     172=head1 TAGS 
     173 
     174If you talk about this module in blogs, on del.icio.us or anywhere else, 
     175please use the C<modulechanges> tag. 
     176 
     177=head1 BUGS AND LIMITATIONS 
     178 
     179No bugs have been reported. 
     180 
     181Please report any bugs or feature requests to 
     182C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     183L<http://rt.cpan.org>. 
     184 
     185=head1 INSTALLATION 
     186 
     187See perlmodinstall for information and options on installing Perl modules. 
     188 
     189=head1 AVAILABILITY 
     190 
     191The latest version of this module is available from the Comprehensive Perl 
     192Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     193site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     194 
     195=head1 AUTHOR 
     196 
     197Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     198 
     199=head1 COPYRIGHT AND LICENSE 
     200 
     201Copyright 2007 by Marcel GrE<uuml>nauer 
     202 
     203This library is free software; you can redistribute it and/or modify 
     204it under the same terms as Perl itself. 
    161205 
    162206=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Formatter.pm

    r9784 r16489  
    2727__END__ 
    2828 
    29 {% USE p = PodGenerated %} 
    30  
    3129=head1 NAME 
    3230 
    … …  
    4442=head1 METHODS 
    4543 
     44This class inherits all methods from L<Module::Changes::Formatter>. 
     45 
    4646=over 4 
    4747 
    48 {% p.write_methods %} 
     48=item format 
     49 
     50An abstract method that is used to format a changes object. Individual 
     51formatters need to override and implement this method. 
    4952 
    5053=item format_to_file 
    … …  
    5760=back 
    5861 
    59 {% p.write_inheritance %} 
     62=head1 TAGS 
    6063 
    61 {% PROCESS standard_pod %} 
     64If you talk about this module in blogs, on del.icio.us or anywhere else, 
     65please use the C<modulechanges> tag. 
     66 
     67=head1 BUGS AND LIMITATIONS 
     68 
     69No bugs have been reported. 
     70 
     71Please report any bugs or feature requests to 
     72C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     73L<http://rt.cpan.org>. 
     74 
     75=head1 INSTALLATION 
     76 
     77See perlmodinstall for information and options on installing Perl modules. 
     78 
     79=head1 AVAILABILITY 
     80 
     81The latest version of this module is available from the Comprehensive Perl 
     82Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     83site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     84 
     85=head1 AUTHOR 
     86 
     87Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     88 
     89=head1 COPYRIGHT AND LICENSE 
     90 
     91Copyright 2007 by Marcel GrE<uuml>nauer 
     92 
     93This library is free software; you can redistribute it and/or modify 
     94it under the same terms as Perl itself. 
    6295 
    6396=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Formatter/Free.pm

    r9784 r16489  
    6666__END__ 
    6767 
    68 {% USE p = PodGenerated %} 
    69  
    7068=head1 NAME 
    7169 
    … …  
    8785=head1 METHODS 
    8886 
     87This class inherits all methods from L<Module::Changes::Formatter>. 
     88 
    8989=over 4 
    9090 
    91 {% p.write_methods %} 
     91=item indent 
     92 
     93    $formatter->indent(4); 
     94    my $indent = $formatter->indent; 
     95 
     96Set or get the indent used to format individual changes and tags lines. The 
     97default is an indent of 4. 
    9298 
    9399=item format_line 
    … …  
    119125=back 
    120126 
    121 {% p.write_inheritance %} 
     127=head1 TAGS 
    122128 
    123 {% PROCESS standard_pod %} 
     129If you talk about this module in blogs, on del.icio.us or anywhere else, 
     130please use the C<modulechanges> tag. 
     131 
     132=head1 BUGS AND LIMITATIONS 
     133 
     134No bugs have been reported. 
     135 
     136Please report any bugs or feature requests to 
     137C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     138L<http://rt.cpan.org>. 
     139 
     140=head1 INSTALLATION 
     141 
     142See perlmodinstall for information and options on installing Perl modules. 
     143 
     144=head1 AVAILABILITY 
     145 
     146The latest version of this module is available from the Comprehensive Perl 
     147Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     148site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     149 
     150=head1 AUTHOR 
     151 
     152Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     153 
     154=head1 COPYRIGHT AND LICENSE 
     155 
     156Copyright 2007 by Marcel GrE<uuml>nauer 
     157 
     158This library is free software; you can redistribute it and/or modify 
     159it under the same terms as Perl itself. 
    124160 
    125161=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Formatter/YAML.pm

    r9784 r16489  
    3838__END__ 
    3939 
    40 {% USE p = PodGenerated %} 
    41  
    4240=head1 NAME 
    4341 
    … …  
    5755=head1 METHODS 
    5856 
     57This class inherits all methods from L<Module::Changes::Formatter>. 
     58 
    5959=over 4 
    60  
    61 {% p.write_methods %} 
    6260 
    6361=item format 
    … …  
    6967=back 
    7068 
    71 {% p.write_inheritance %} 
     69=head1 TAGS 
    7270 
    73 {% PROCESS standard_pod %} 
     71If you talk about this module in blogs, on del.icio.us or anywhere else, 
     72please use the C<modulechanges> tag. 
     73 
     74=head1 BUGS AND LIMITATIONS 
     75 
     76No bugs have been reported. 
     77 
     78Please report any bugs or feature requests to 
     79C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     80L<http://rt.cpan.org>. 
     81 
     82=head1 INSTALLATION 
     83 
     84See perlmodinstall for information and options on installing Perl modules. 
     85 
     86=head1 AVAILABILITY 
     87 
     88The latest version of this module is available from the Comprehensive Perl 
     89Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     90site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     91 
     92=head1 AUTHOR 
     93 
     94Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     95 
     96=head1 COPYRIGHT AND LICENSE 
     97 
     98Copyright 2007 by Marcel GrE<uuml>nauer 
     99 
     100This library is free software; you can redistribute it and/or modify 
     101it under the same terms as Perl itself. 
    74102 
    75103=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Parser.pm

    r9784 r16489  
    3434__END__ 
    3535 
    36 {% USE p = PodGenerated %} 
    37  
    3836=head1 NAME 
    3937 
    … …  
    5149=head1 METHODS 
    5250 
     51This class inherits all methods from L<Module::Changes::Base>. 
     52 
    5353=over 4 
    5454 
    55 {% p.write_methods %} 
     55=item parse_string 
     56 
     57An abstract method that is used to parse a string into a Changes object. 
     58Individual parsers need to override and implement this method. 
    5659 
    5760=item parse_from_filehandle 
    … …  
    7174=back 
    7275 
    73 {% p.write_inheritance %} 
     76=head1 TAGS 
    7477 
    75 {% PROCESS standard_pod %} 
     78If you talk about this module in blogs, on del.icio.us or anywhere else, 
     79please use the C<modulechanges> tag. 
     80 
     81=head1 BUGS AND LIMITATIONS 
     82 
     83No bugs have been reported. 
     84 
     85Please report any bugs or feature requests to 
     86C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     87L<http://rt.cpan.org>. 
     88 
     89=head1 INSTALLATION 
     90 
     91See perlmodinstall for information and options on installing Perl modules. 
     92 
     93=head1 AVAILABILITY 
     94 
     95The latest version of this module is available from the Comprehensive Perl 
     96Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     97site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     98 
     99=head1 AUTHOR 
     100 
     101Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     102 
     103=head1 COPYRIGHT AND LICENSE 
     104 
     105Copyright 2007 by Marcel GrE<uuml>nauer 
     106 
     107This library is free software; you can redistribute it and/or modify 
     108it under the same terms as Perl itself. 
    76109 
    77110=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Parser/Free.pm

    r9784 r16489  
    84841; 
    8585 
    86  
    8786__END__ 
    88  
    89 {% USE p = PodGenerated %} 
    9087 
    9188=head1 NAME 
    … …  
    128125=head1 METHODS 
    129126 
     127This class inherits all methods from L<Module::Changes::Parser>. 
     128 
    130129=over 4 
    131  
    132 {% p.write_methods %} 
    133130 
    134131=item parse_string 
    … …  
    141138=back 
    142139 
    143 {% p.write_inheritance %} 
     140=head1 TAGS 
    144141 
    145 {% PROCESS standard_pod %} 
     142If you talk about this module in blogs, on del.icio.us or anywhere else, 
     143please use the C<modulechanges> tag. 
     144 
     145=head1 BUGS AND LIMITATIONS 
     146 
     147No bugs have been reported. 
     148 
     149Please report any bugs or feature requests to 
     150C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     151L<http://rt.cpan.org>. 
     152 
     153=head1 INSTALLATION 
     154 
     155See perlmodinstall for information and options on installing Perl modules. 
     156 
     157=head1 AVAILABILITY 
     158 
     159The latest version of this module is available from the Comprehensive Perl 
     160Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     161site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     162 
     163=head1 AUTHOR 
     164 
     165Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     166 
     167=head1 COPYRIGHT AND LICENSE 
     168 
     169Copyright 2007 by Marcel GrE<uuml>nauer 
     170 
     171This library is free software; you can redistribute it and/or modify 
     172it under the same terms as Perl itself. 
    146173 
    147174=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Parser/YAML.pm

    r9784 r16489  
    43431; 
    4444 
    45  
    4645__END__ 
    47  
    48 {% USE p = PodGenerated %} 
    4946 
    5047=head1 NAME 
    … …  
    6562=head1 METHODS 
    6663 
     64This class inherits all methods from L<Module::Changes::Parser>. 
     65 
    6766=over 4 
    68  
    69 {% p.write_methods %} 
    7067 
    7168=item parse_string 
    … …  
    7875=back 
    7976 
    80 {% p.write_inheritance %} 
     77=head1 TAGS 
    8178 
    82 {% PROCESS standard_pod %} 
     79If you talk about this module in blogs, on del.icio.us or anywhere else, 
     80please use the C<modulechanges> tag. 
     81 
     82=head1 BUGS AND LIMITATIONS 
     83 
     84No bugs have been reported. 
     85 
     86Please report any bugs or feature requests to 
     87C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     88L<http://rt.cpan.org>. 
     89 
     90=head1 INSTALLATION 
     91 
     92See perlmodinstall for information and options on installing Perl modules. 
     93 
     94=head1 AVAILABILITY 
     95 
     96The latest version of this module is available from the Comprehensive Perl 
     97Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     98site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     99 
     100=head1 AUTHOR 
     101 
     102Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     103 
     104=head1 COPYRIGHT AND LICENSE 
     105 
     106Copyright 2007 by Marcel GrE<uuml>nauer 
     107 
     108This library is free software; you can redistribute it and/or modify 
     109it under the same terms as Perl itself. 
    83110 
    84111=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Release.pm

    r9784 r16489  
    6161__END__ 
    6262 
    63 {% USE p = PodGenerated %} 
    64  
    6563=head1 NAME 
    6664 
    … …  
    7371    $release->touch_date; 
    7472 
    75     $release->date(DateTime::Format::W3CDTF->new->parse_datetime(...)); 
    76     print DateTime::Format::Mail->new->format_datetime($release->date); 
    77  
    7873=head1 DESCRIPTION 
    7974 
    80 This class represents a release within the Changes file. The date is a 
    81 L<DateTime> object. 
    82  
    83 Releases can also have tags. Tags are a way to help other programs understand 
    84 (or at least guess) what has happened in each release. Tags are just strings. 
    85 See the documentation for the C<changes> program for a discussion of 
    86 recommended tags. 
     75This class represents a release within the Changes file. 
    8776 
    8877=head1 METHODS 
    8978 
     79This class inherits all methods from L<Module::Changes::Base>. 
     80 
    9081=over 4 
    9182 
    92 {% p.write_methods %} 
     83=item version 
     84 
     85    $release->version(Perl::Version->new->('0.01')); 
     86    print $release->version; 
     87 
     88Set or get the release's version number. You need to use a L<Perl::Version> 
     89object. 
    9390 
    9491=item version_as_string 
    … …  
    9794 
    9895Takes the release's version object and returns a string representation. 
     96 
     97=item date 
     98 
     99    $release->date(DateTime::Format::W3CDTF->new->parse_datetime(...)); 
     100    print DateTime::Format::Mail->new->format_datetime($release->date); 
     101 
     102Set or get the release's date. You need to use a L<DateTime> object. 
     103 
     104=item author 
     105 
     106    $release->author('Marcel Gruenauer <marcel@cpan.org>'); 
     107    print $release->author; 
     108 
     109Set or get the release's author. It is recommended that you use a string as 
     110shown above. 
     111 
     112=item changes 
     113 
     114    $release->changes_push('Added foobar()'); 
     115    for my $change ($release->changes) { ... } 
     116 
     117This is an array accessor giving access to all the changes contained in the 
     118release. See L<Class::Accessor::Complex>'s C<mk_array_accessors()> for which 
     119methods are available. 
     120 
     121Changes are just strings. 
     122 
     123=item tags 
     124 
     125    $release->tags_push('APIBREAK'); 
     126    for my $tag ($release->tags) { ... } 
     127 
     128This is an array accessor giving access to all the tags contained in the 
     129release. See L<Class::Accessor::Complex>'s C<mk_array_accessors()> for which 
     130methods are available. 
     131 
     132Tags are a way to help other programs understand (or at least guess) what has 
     133happened in each release. 
     134 
     135Tags are just strings. See the documentation for the C<changes> program for a 
     136discussion of recommended tags. 
    99137 
    100138=item touch_date 
    … …  
    120158=back 
    121159 
    122 {% p.write_inheritance %} 
     160=head1 TAGS 
    123161 
    124 {% PROCESS standard_pod %} 
     162If you talk about this module in blogs, on del.icio.us or anywhere else, 
     163please use the C<modulechanges> tag. 
     164 
     165=head1 BUGS AND LIMITATIONS 
     166 
     167No bugs have been reported. 
     168 
     169Please report any bugs or feature requests to 
     170C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     171L<http://rt.cpan.org>. 
     172 
     173=head1 INSTALLATION 
     174 
     175See perlmodinstall for information and options on installing Perl modules. 
     176 
     177=head1 AVAILABILITY 
     178 
     179The latest version of this module is available from the Comprehensive Perl 
     180Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     181site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     182 
     183=head1 AUTHOR 
     184 
     185Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     186 
     187=head1 COPYRIGHT AND LICENSE 
     188 
     189Copyright 2007 by Marcel GrE<uuml>nauer 
     190 
     191This library is free software; you can redistribute it and/or modify 
     192it under the same terms as Perl itself. 
    125193 
    126194=cut 

  • lang/perl/Module-Changes/trunk/lib/Module/Changes/Validator/YAML.pm

    r9784 r16489  
    5757__END__ 
    5858 
    59 {% USE p = PodGenerated %} 
    60  
    6159=head1 NAME 
    6260 
    63 Module::Changes::Validator::YAML - validate a YAML Changes string 
     61Module::Changes::Formatter::YAML - format a Changes object as YAML 
    6462 
    6563=head1 SYNOPSIS 
    6664 
    6765    use Module::Changes; 
    68     my $validator = Module::Changes->make_object_for_type('validator_yaml'); 
    69     $validatew->validate($yaml); 
     66    my $formatter = Module::Changes->make_object_for_type('formatter_yaml'); 
     67    $formatter->format($changes); 
    7068 
    7169=head1 DESCRIPTION 
    7270 
    73 This class can validate YAML strings. The required layout of the YAML file is 
     71This class can format a Changes object as YAML. The layout of the YAML file is 
    7472documented in L<Module::Changes>. 
    7573 
    7674=head1 METHODS 
    7775 
     76This class inherits all methods from L<Module::Changes::Formatter>. 
     77 
    7878=over 4 
    7979 
    80 {% p.write_methods %} 
     80=item format 
    8181 
    82 =item validate 
     82    print $formatter->format($changes); 
    8383 
    84     print $validator->validate($yaml); 
    85  
    86 Takes a YAML string and validates it, returning a boolean value. 
     84Takes a changes object and formats it as YAML, then returns the result string. 
    8785 
    8886=back 
    8987 
    90 {% p.write_inheritance %} 
     88=head1 TAGS 
    9189 
    92 {% PROCESS standard_pod %} 
     90If you talk about this module in blogs, on del.icio.us or anywhere else, 
     91please use the C<modulechanges> tag. 
     92 
     93=head1 BUGS AND LIMITATIONS 
     94 
     95No bugs have been reported. 
     96 
     97Please report any bugs or feature requests to 
     98C<bug-module-changes@rt.cpan.org>, or through the web interface at 
     99L<http://rt.cpan.org>. 
     100 
     101=head1 INSTALLATION 
     102 
     103See perlmodinstall for information and options on installing Perl modules. 
     104 
     105=head1 AVAILABILITY 
     106 
     107The latest version of this module is available from the Comprehensive Perl 
     108Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     109site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     110 
     111=head1 AUTHOR 
     112 
     113Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     114 
     115=head1 COPYRIGHT AND LICENSE 
     116 
     117Copyright 2007 by Marcel GrE<uuml>nauer 
     118 
     119This library is free software; you can redistribute it and/or modify 
     120it under the same terms as Perl itself. 
    93121 
    94122=cut