Return to Todo.pm CVS log

Up to [local] / todotxt / Text-Todo / lib / Text

Annotation of todotxt/Text-Todo/lib/Text/Todo.pm, Revision 1.1.1.1

1.1       andrew      1: package Text::Todo;
                      2:
                      3: # $RedRiver$
                      4:
                      5: use warnings;
                      6: use strict;
                      7: use Carp;
                      8:
                      9: use version; our $VERSION = qv('0.0.1');
                     10:
                     11: # Other recommended modules (uncomment to use):
                     12: #  use IO::Prompt;
                     13: #  use Perl6::Export;
                     14: #  use Perl6::Slurp;
                     15: #  use Perl6::Say;
                     16:
                     17:
                     18: # Module implementation here
                     19:
                     20:
                     21: 1; # Magic true value required at end of module
                     22: __END__
                     23:
                     24: =head1 NAME
                     25:
                     26: Text::Todo - [One line description of module's purpose here]
                     27:
                     28:
                     29: =head1 VERSION
                     30:
                     31: This document describes Text::Todo version 0.0.1
                     32:
                     33:
                     34: =head1 SYNOPSIS
                     35:
                     36:     use Text::Todo;
                     37:
                     38: =for author to fill in:
                     39:     Brief code example(s) here showing commonest usage(s).
                     40:     This section will be as far as many users bother reading
                     41:     so make it as educational and exeplary as possible.
                     42:
                     43:
                     44: =head1 DESCRIPTION
                     45:
                     46: =for author to fill in:
                     47:     Write a full description of the module and its features here.
                     48:     Use subsections (=head2, =head3) as appropriate.
                     49:
                     50:
                     51: =head1 INTERFACE
                     52:
                     53: =for author to fill in:
                     54:     Write a separate section listing the public components of the modules
                     55:     interface. These normally consist of either subroutines that may be
                     56:     exported, or methods that may be called on objects belonging to the
                     57:     classes provided by the module.
                     58:
                     59:
                     60: =head1 DIAGNOSTICS
                     61:
                     62: =for author to fill in:
                     63:     List every single error and warning message that the module can
                     64:     generate (even the ones that will "never happen"), with a full
                     65:     explanation of each problem, one or more likely causes, and any
                     66:     suggested remedies.
                     67:
                     68: =over
                     69:
                     70: =item C<< Error message here, perhaps with %s placeholders >>
                     71:
                     72: [Description of error here]
                     73:
                     74: =item C<< Another error message here >>
                     75:
                     76: [Description of error here]
                     77:
                     78: [Et cetera, et cetera]
                     79:
                     80: =back
                     81:
                     82:
                     83: =head1 CONFIGURATION AND ENVIRONMENT
                     84:
                     85: =for author to fill in:
                     86:     A full explanation of any configuration system(s) used by the
                     87:     module, including the names and locations of any configuration
                     88:     files, and the meaning of any environment variables or properties
                     89:     that can be set. These descriptions must also include details of any
                     90:     configuration language used.
                     91:
                     92: Text::Todo requires no configuration files or environment variables.
                     93:
                     94:
                     95: =head1 DEPENDENCIES
                     96:
                     97: =for author to fill in:
                     98:     A list of all the other modules that this module relies upon,
                     99:     including any restrictions on versions, and an indication whether
                    100:     the module is part of the standard Perl distribution, part of the
                    101:     module's distribution, or must be installed separately. ]
                    102:
                    103: None.
                    104:
                    105:
                    106: =head1 INCOMPATIBILITIES
                    107:
                    108: =for author to fill in:
                    109:     A list of any modules that this module cannot be used in conjunction
                    110:     with. This may be due to name conflicts in the interface, or
                    111:     competition for system or program resources, or due to internal
                    112:     limitations of Perl (for example, many modules that use source code
                    113:     filters are mutually incompatible).
                    114:
                    115: None reported.
                    116:
                    117:
                    118: =head1 BUGS AND LIMITATIONS
                    119:
                    120: =for author to fill in:
                    121:     A list of known problems with the module, together with some
                    122:     indication Whether they are likely to be fixed in an upcoming
                    123:     release. Also a list of restrictions on the features the module
                    124:     does provide: data types that cannot be handled, performance issues
                    125:     and the circumstances in which they may arise, practical
                    126:     limitations on the size of data sets, special cases that are not
                    127:     (yet) handled, etc.
                    128:
                    129: No bugs have been reported.
                    130:
                    131: Please report any bugs or feature requests to
                    132: C<bug-text-todo@rt.cpan.org>, or through the web interface at
                    133: L<http://rt.cpan.org>.
                    134:
                    135:
                    136: =head1 AUTHOR
                    137:
                    138: Andrew Fresh  C<< <andrew@cpan.org> >>
                    139:
                    140:
                    141: =head1 LICENSE AND COPYRIGHT
                    142:
                    143: Copyright (c) 2009, Andrew Fresh C<< <andrew@cpan.org> >>. All rights reserved.
                    144:
                    145: This module is free software; you can redistribute it and/or
                    146: modify it under the same terms as Perl itself. See L<perlartistic>.
                    147:
                    148:
                    149: =head1 DISCLAIMER OF WARRANTY
                    150:
                    151: BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
                    152: FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
                    153: OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
                    154: PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
                    155: EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
                    156: WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
                    157: ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
                    158: YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
                    159: NECESSARY SERVICING, REPAIR, OR CORRECTION.
                    160:
                    161: IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
                    162: WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
                    163: REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
                    164: LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
                    165: OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
                    166: THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
                    167: RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
                    168: FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
                    169: SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
                    170: SUCH DAMAGES.