Skip to content

Commit

Permalink
Updated POD
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Ober committed May 21, 2012
1 parent 2b6e746 commit 814ebd6
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 19 deletions.
9 changes: 7 additions & 2 deletions lib/Reddit/API.pm
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,12 @@ Internal method; helper for C<login>.
=item me
Returns a Reddit::API::Account object
Returns a Reddit::API::Account object.
=item callback_me
Internal method; helper for C<me>.
=item list_subreddits($type)
Expand Down Expand Up @@ -778,7 +783,7 @@ parameter.
Submits a new comment underneath C<parent_id>.
=item callback_sbumit_comment
=item callback_submit_comment
Internal method; helper for C<submit_comment>.
Expand Down
5 changes: 0 additions & 5 deletions lib/Reddit/API/Comment.pm
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,6 @@ Syntactic sugar for C<Reddit::API::submit_comment()>.
=over
=item set_likes
Conditionally sets the value of "likes" since it may validly be true, false, or
neither, in the case of no vote being cast.
=item set_replies
Wraps the list of children in Comment class instances and ensures that comments
Expand Down
11 changes: 0 additions & 11 deletions lib/Reddit/API/Link.pm
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,6 @@ Wraps C<Reddit::API::get_comments>, implicitly providing the permalink parameter
=back
=head1 INTERNAL ROUTINES
=over
=item set_likes
Conditionally sets the value of "likes" since it may validly be true, false, or
neither, in the case of no vote being cast.
=back
=head1 AUTHOR
Jeff Ober L<mailto:[email protected]>
Expand Down
54 changes: 53 additions & 1 deletion lib/Reddit/API/Request.pm
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,56 @@ sub send {
}
}

1;
1;

__END__
=pod
=head1 NAME
Reddit::API::Request
=head1 DESCRIPTION
HTTP request driver for Reddit::API. Uses LWP to perform GET and POST requests
to the reddit.com servers. This module is used internally by the Reddit::API
and is not designed for external use.
=head1 SUBROUTINES/METHODS
=over
=item new(%params)
Creates a new Reddit::Request::API instance. Parameters:
user_agent User agent string
url Target URL
query Hash of query parameters
post_data Hash of POST parameters
cookie Reddit session cookie
modhash Reddit session modhash
=item build_query($query)
Builds a URI-escaped query string from a hash of query parameters.
=item send
Performs the HTTP request and returns the result. Croaks on HTTP error.
=back
=head1 AUTHOR
Jeff Ober L<mailto:[email protected]>
=head1 LICENSE
BSD license
=cut
10 changes: 10 additions & 0 deletions lib/Reddit/API/VotableThing.pm
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,16 @@ commented against, hidden, or saved.
=item unhide()
=back
=head1 INTERNAL ROUTINES
=over
=item set_likes
Conditionally sets the value of "likes" since it may validly be true, false, or
neither, in the case of no vote being cast.
=back
Expand Down

0 comments on commit 814ebd6

Please sign in to comment.