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