Permalink
Browse files

I discovered the podchecker utility, and ran it on POE's

documentation.  Ow!  The errors are fixed, but not the warnings.
  • Loading branch information...
1 parent 0e41005 commit dddc865e8f21c770138150fa042df79d516ee88a @rcaputo committed Oct 26, 2002
View
@@ -377,6 +377,8 @@ writing TCP clients.
The Server::TCP component provides the most common core features for
writing TCP servers. A simple echo server is about 20 lines.
+=back
+
=head1 Support Modules
Finally, there are some files which POE uses but aren't required
@@ -402,6 +404,8 @@ POE::Component, POE::Driver and POE::Filter exist to document their
classes of objects. POE::Wheel contains some base functions for
tracking unique wheel IDs.
+=back
+
=head1 SAMPLE PROGRAMS
This distribution contains several example and/or tutorial programs in
@@ -147,6 +147,8 @@ to use.
See POE::Filter.
+=back
+
=head1 SEE ALSO
POE::Filter; POE::Filter::Grep; POE::Filter::Line;
@@ -140,6 +140,8 @@ to use.
See POE::Filter.
+=back
+
=head1 SEE ALSO
POE::Filter; POE::Filter::Grep; POE::Filter::Line;
@@ -309,21 +309,27 @@ The new() method will try to require any packages it needs.
The default behavior is to try Storable first, FreezeThaw second, YAML
third, and finally fail.
-=item *
+=item get [ FROZEN_DATA ]
-POE::Filter::Reference::get($frozen_data)
+The get() method thaws a referenced list of FROZEN_DATA chunks back
+into references. References will be blessed, if necessary. If the
+references points to an object, be sure the receiving end has used the
+appropriate modules before calling their methods.
-The get() method thaws streamed, frozen data into references.
-References will be blessed, if necessary. If the reference points to
-an object, be sure the receiving end has use'd it before calling its
-methods.
+ $thingrefs = $filter_reference->get(\@stream_chunks);
+ foreach (@$thingrefs) {
+ ...;
+ }
-=item *
+=item put [ REFERENCES ]
-POE::Filter::Reference::put($reference)
+The put() method freezes one or more REFERENCES and returns their
+serialized, streamable representations as a list reference.
-The put() method freezes references and returns their serialized,
-streamable representations.
+ $listref = $filter_reference->put([ \%thing_one, \@thing_two ]);
+ foreach (@$listref) {
+ ...;
+ }
=back
@@ -187,6 +187,8 @@ Stackable filter, in order from near to far.
See POE::Filter.
+=back
+
=head1 SEE ALSO
POE::Filter; POE::Filter::HTTPD; POE::Filter::Reference;
View
@@ -3967,13 +3967,7 @@ arguments to EVENT_NAME's handler.
The post() method returns a boolean value indicating whether the event
was enqueued successfully. $! will explain why the post() failed:
-=over 2
-
-=item ESRCH
-
-SESSION did not exist at the time of the post() call.
-
-=back
+ESRCH: The SESSION did not exist at the time of the post() call.
Posted events keep both the sending and receiving session alive until
they're dispatched.
@@ -4037,11 +4031,7 @@ was dispatched.
Reasons why call() might fail:
-=over 2
-
-=item ESRCH
-
-SESSION did not exist at the time call() was called.
+ESRCH: The SESSION did not exist at the time call() was called.
=back
@@ -4363,18 +4353,11 @@ once they are removed.
alias_remove() returns 0 on success or a reason for its failure:
-=over 2
-
-=item ESRCH
+ESRCH: The Kernel's dictionary does not include the ALIAS being
+removed.
-The Kernel's dictionary does not include the ALIAS being removed.
-
-=item EPERM
-
-ALIAS belongs to some other session, and the current one does not have
-the authority to clear it.
-
-=back
+EPERM: ALIAS belongs to some other session, and the current one does
+not have the authority to clear it.
=item alias_resolve ALIAS
@@ -4397,13 +4380,7 @@ A numeric session ID:
alias_resolve() returns undef upon failure, setting $! to explain the
error:
-=over 2
-
-=item ESRCH
-
-The Kernel's dictionary does not include ALIAS.
-
-=back
+ESRCH: The Kernel's dictionary does not include ALIAS.
These functions work directly with session IDs. They are faster than
alias_resolve() in the specific cases where they're useful.
@@ -4416,15 +4393,9 @@ session ID.
$session_reference = ID_id_to_session( $session_id );
It returns undef if a lookup fails, and it sets $! to explain why the
-lookup failed.
+lookup failed:
-=over 2
-
-=item ESRCH
-
-The session ID does not refer to a running session.
-
-=back
+ESRCH: The session ID does not refer to a running session.
=item alias_list SESSION
@@ -4453,14 +4424,8 @@ work, provided that the session exists:
ID_session_to_id() returns undef if a lookup fails, and it sets $! to
explain why the lookup failed.
-=over 2
-
-=item ESRCH
-
-The session reference does not describe a session which is currently
-running.
-
-=back
+ESRCH: The session reference does not describe a session which is
+currently running.
=back
@@ -4892,12 +4857,8 @@ The sixth form maps an event to a function with a different name.
POE::Kernel's state() method returns 0 on success or a nonzero code
explaining why it failed:
-=over 2
-
-=item ESRCH
-
-The Kernel doesn't recognize the currently active session. This
-happens when state() is called when no session is active.
+ESRCH: The Kernel doesn't recognize the currently active session.
+This happens when state() is called when no session is active.
=back
@@ -4930,13 +4891,7 @@ returning the reference count after the decrement.
Both methods return undef on failure and set $! to explain the
failure.
-=over 2
-
-=item ESRCH
-
-There is no session SESSION_ID currently active.
-
-=back
+ESRCH: There is no session SESSION_ID currently active.
=back
@@ -413,7 +413,7 @@ see L<POE::Loop> for its documentation.
=head1 SEE ALSO
-L<POE>, L<POE::Loop>, L<select(2)>
+L<POE>, L<POE::Loop>, L<select>
=head1 AUTHORS & LICENSING
@@ -1422,7 +1422,7 @@ Clear the screen and repaint the prompt and current input line.
=item Enter / Return
-C-m is the newline keystroke on Unix-y systems. It ends text entry,
+C-m is the newline keystroke on DOSsy systems. It ends text entry,
firing an InputEvent with C<ARG0> containing the entered text (without
the terminating newline). C<ARG1> is undefined because there is no
exception.
@@ -1704,10 +1704,6 @@ A: You probably are using print or printf to write screen output.
refresh the prompt after you do this. Use ReadLine's put() method
to write lines to the console.
-=head1 BUGS
-
-I am not sure how well this supports unicode.
-
=head1 AUTHORS & COPYRIGHTS
Please see L<POE> for more information about authors and contributors.

0 comments on commit dddc865

Please sign in to comment.