Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

First working implementation

  • Loading branch information...
commit 722d5b41a7b79e4f20de701302a2e715778b8242 1 parent 8663fad
@DarwinAwardWinner authored
View
62 README.pod
@@ -0,0 +1,62 @@
+=pod
+
+=head1 NAME
+
+Pod::Weaver::Section::WarrantyDisclaimer - add a standard DISCLAIMER OF WARRANTY section (for your Perl module)
+
+=head1 VERSION
+
+version 0.103510
+
+=head1 SYNOPSIS
+
+In F<weaver.ini>, probably near the end:
+
+ [WarrantyDisclaimer]
+
+=head1 OVERVIEW
+
+This section plugin will add the standard B<DISCLAIMER OF WARRANTY>
+section to your POD. See the bottom of this module's documentation for
+the content. of this section.
+
+=for Pod::Coverage weave_section
+
+=head1 INSTALLATION
+
+See perlmodinstall for information and options on installing Perl modules.
+
+=head1 AUTHOR
+
+Ryan C. Thompson <rct@thompsonclan.org>
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2010 by Ryan C. Thompson.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=head1 DISCLAIMER OF WARRANTY
+
+BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
+WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
+PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
+EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
+TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
View
1  dist.ini
@@ -6,3 +6,4 @@ copyright_holder = Ryan C. Thompson
copyright_year = 2010
[@RTHOMPSON]
+synopsis_is_perl_code = false
View
91 lib/Pod/Weaver/Section/WarrantyDisclaimer.pm
@@ -1,56 +1,73 @@
use strict;
use warnings;
-use utf8;
package Pod::Weaver::Section::WarrantyDisclaimer;
-# ABSTRACT: [1-line description of module]
-# [MODULE IMPLEMENTATION GOES HERE]
+use Moose;
+with 'Pod::Weaver::Role::Section';
+# ABSTRACT: add a standard DISCLAIMER OF WARRANTY section (for your Perl module)
-1; # Magic true value required at end of module
-__END__
+use Moose::Autobox;
-=head1 SYNOPSIS
+use Pod::Elemental::Element::Pod5::Ordinary;
+use Pod::Elemental::Element::Nested;
- use Pod::Weaver::Section::WarrantyDisclaimer;
+=for Pod::Coverage weave_section
- [Sample usage of module]
+=cut
-=head1 DESCRIPTION
+sub weave_section {
+ my ($self, $document) = @_;
-[EXPLAIN]
+ my $content = <<'EOF';
+BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
+WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
+PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
+EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
-=head1 BUGS AND LIMITATIONS
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
+TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+EOF
-[KNOWN BUGS]
+ my $warranty_para = Pod::Elemental::Element::Nested->new({
+ command => 'head1',
+ content => 'DISCLAIMER OF WARRANTY',
+ children => [
+ Pod::Elemental::Element::Pod5::Ordinary->new({ content => $content }),
+ ],
+ });
-Please report any bugs or feature requests to
-C<rct+perlbug@thompsonclan.org>.
+ $document->children->push($warranty_para);
+}
-=head1 SEE ALSO
+1;
-=for :list
-[* L<Related::Module> - How it is related]
+__END__
+=pod
-=head1 DISCLAIMER OF WARRANTY
+=head1 SYNOPSIS
-BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
-EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
-ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
-YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
-NECESSARY SERVICING, REPAIR, OR CORRECTION.
+In F<weaver.ini>, probably near the end:
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
-LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
-OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
-THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
+ [WarrantyDisclaimer]
+
+=head1 OVERVIEW
+
+This section plugin will add the standard B<DISCLAIMER OF WARRANTY>
+section to your POD. See the bottom of this module's documentation for
+the content. of this section.
+
+=cut
View
34 weaver.ini
@@ -1,4 +1,36 @@
-[@Default]
+; weaver.ini
+[@CorePrep]
+
+[Name]
+[Version]
+
+[Region / prelude]
+
+[Generic / SYNOPSIS]
+[Generic / DESCRIPTION]
+[Generic / OVERVIEW]
+
+[Collect / ATTRIBUTES]
+command = attr
+
+[Collect / OPTIONS]
+command = option
+
+[Collect / METHODS]
+command = method
+
+[Collect / FUNCTIONS]
+command = function
+
+[Leftovers]
+
+[Region / postlude]
+
+[Installation]
+
+[Authors]
+[Legal]
+[WarrantyDisclaimer]
[-Transformer]
transformer = List
Please sign in to comment.
Something went wrong with that request. Please try again.