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