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