Permalink
Browse files

Use Z<> to remove all TODOs from formatted Pod

  • Loading branch information...
1 parent 88db91a commit 5c2367d830051321fbf256bfab91beb843d30c40 @hinrik hinrik committed Apr 23, 2011
View
4 lib/POE.pm
@@ -685,8 +685,8 @@ author of L<Sprocket>, a networking framework built on POE.
Please contact the author if you've been forgotten and would like to
be included here.
-TODO - This section has fallen into disrepair. A POE historian needs
-to cull the CHANGES for the names of major contributors.
+Z<TODO - This section has fallen into disrepair. A POE historian needs
+to cull the CHANGES for the names of major contributors.>
=back
View
10 lib/POE/Component/Server/TCP.pm
@@ -744,8 +744,8 @@ connection---and not in the master listening session. This has been a
major point of confusion. We welcome suggestions for making this
clearer.
-TODO - Document some of the implications of having each connection
-handled by a separate session.
+Z<TODO - Document some of the implications of having each connection
+handled by a separate session.>
The component's C<ClientInput> callback defines how child sessions
will handle input from their clients. Its parameters are that of
@@ -848,7 +848,7 @@ They are covered briefly again below.
These constructor parameters affect POE::Component::Server::TCP's main
listening session.
-TODO - Document the shutdown procedure somewhere.
+Z<TODO - Document the shutdown procedure somewhere.>
=head4 Acceptor
@@ -885,7 +885,7 @@ supports. At the time of this writing, that may be a dotted IPv4
quad, an IPv6 address, a host name, or a packed Internet address. See
also L</Hostname>.
-TODO - Example, using the lines below.
+Z<TODO - Example, using the lines below.>
Address => '127.0.0.1' # Localhost IPv4
Address => "::1" # Localhost IPv6
@@ -1410,7 +1410,7 @@ Some use cases require different session classes for the listener and
the connection handlers. This isn't currently supported. Please send
patches. :)
-TODO - Document that Reuse is set implicitly.
+Z<TODO - Document that Reuse is set implicitly.>
=head1 AUTHORS & COPYRIGHTS
View
6 lib/POE/Loop.pm
@@ -555,11 +555,13 @@ L<POE::Test::Loops> is POE's event loop tests released as a separate,
reusable distribution. POE::Loop authors are encouraged to use the
tests for their own distributions.
-TODO - Link to CPAN for POE::Loop modules.
+Z<TODO - Link to CPAN for POE::Loop modules.>
=head1 BUGS
-TODO - Link to POE bug queue.
+None known.
+
+Z<TODO - Link to POE bug queue.>
=head1 AUTHORS & LICENSING
View
6 lib/POE/Queue.pm
@@ -290,10 +290,10 @@ L<POE>, L<POE::Queue::Array>
None known.
-TODO - Should set_priority return the old priority instead of the new
-one?
+Z<TODO - Should set_priority return the old priority instead of the new
+one?>
-TODO - Rename and repackage as its own distribution.
+Z<TODO - Rename and repackage as its own distribution.>
=head1 AUTHORS & COPYRIGHTS
View
35 lib/POE/Session.pm
@@ -1028,8 +1028,8 @@ current ones.
$_[KERNEL]->post( $_[SENDER], "echo", @_[ARG0..$#_] );
}
-TODO - Document which events should have $_[SENDER] == $_[KERNEL].
-Probably in POE::Kernel.
+Z<TODO - Document which events should have $_[SENDER] == $_[KERNEL].
+Probably in POE::Kernel.>
=head3 $_[CALLER_FILE], $_[CALLER_LINE] and $_[CALLER_STATE]
@@ -1039,7 +1039,7 @@ are fairly plain. CALLER_STATE contains the name of the event that
was being handled when the event was created, or when the event
watcher that ultimately created the event was registered.
-TODO - Rename SENDER_FILE, SENDER_LINE, SENDER_STATE?
+Z<TODO - Rename SENDER_FILE, SENDER_LINE, SENDER_STATE?>
=head3 @_[ARG0..ARG9] or @_[ARG0..$#_]
@@ -1137,27 +1137,24 @@ application code has not saved a copy of it.
C<create()> accepts several named parameters, most of which are optional.
Note however that the parameters are not part of a hashref.
-TODO - Is it time to bring new() back as a synonym for create()?
-TODO PG - NO! IMHO ->new implies simply creating the object, and
-TODO that you have to hold onto the object. ->create implies other actions
-TODO are happening, and that you don't want to hold on to it.
+Z<< Is it time to bring new() back as a synonym for create()?
+PG - NO! IMHO ->new implies simply creating the object, and
+that you have to hold onto the object. ->create implies other actions
+are happening, and that you don't want to hold on to it. >>
-TODO - Provide forward-compatible "handler" options and methods as
+Z<TODO - Provide forward-compatible "handler" options and methods as
synonyms for the "state" versions currently supported?
-TODO PG - No, that's for 1.01
+PG - No, that's for 1.01>
-TODO - Add a "class_handlers" as a synonym for "package_handlers"?
-TODO PG - Maybe. However, to many synonyms can be a pain for an API.
+Z<TODO - Add a "class_handlers" as a synonym for "package_handlers"?
+PG - Maybe. However, to many synonyms can be a pain for an API.>
-TODO - The above TODOs may be summarized: "deprecate old language"?
-TODO PG - Oh, you are thinking of deprecating the old language... erm... no?
+Z<TODO - The above TODOs may be summarized: "deprecate old language"?
+PG - Oh, you are thinking of deprecating the old language... erm... no?>
-
-
-TODO PG - I notice these =head3 are in alphabetical order. I think
+Z<TODO PG - I notice these =head3 are in alphabetical order. I think
TODO all the *_states options should be together. Followed by heap, args,
-TODO options
-
+TODO options>
=head3 args => ARRAYREF
@@ -1636,7 +1633,7 @@ ASSERT_STATES by defaulting the "default" option to true instead of
false. See the option() method earlier in this document for details
about the "default" option.
-TODO - It's not much of an assertion if it only warns.
+Z<TODO - It's not much of an assertion if it only warns.>
=head1 SEE ALSO
View
2 lib/POE/Wheel.pm
@@ -324,7 +324,7 @@ L<POE::Wheel::Run> - Non-blocking process creation and management.
L<POE::Wheel::SocketFactory> - Non-blocking socket creation,
supporting most protocols and modes.
-TODO - Link to POE::Wheel search.cpan.org module search.
+Z<TODO - Link to POE::Wheel search.cpan.org module search.>
=head1 BUGS
View
6 lib/POE/Wheel/FollowTail.pm
@@ -770,7 +770,7 @@ C<Seek> may also be used with the wheel's tell() method to restore the
file position after a program restart. Save the tell() value prior to
exiting, and load and C<Seek> back to it on subsequent start-up.
-TODO - Example.
+Z<TODO - Example.>
=head3 SeekBack
@@ -784,7 +784,7 @@ C<Seek> and C<SeekBack> are mutually exclusive.
See L</Seek> for caveats, techniques, and an explanation of the magic
that happens when neither C<Seek> nor C<SeekBack> is specified.
-TODO - Example.
+Z<TODO - Example.>
=head3 Handle
@@ -800,7 +800,7 @@ purview.
C<Handle> and C<Filename> are mutually exclusive. One of them is
required, however.
-TODO - Example.
+Z<TODO - Example.>
=head3 Filename
View
8 lib/POE/Wheel/ReadLine.pm
@@ -3216,7 +3216,7 @@ action.
get_history() returns a list containing POE::Wheel::ReadLine's current
input history. It may not contain everything entered into the wheel
-TODO - Example.
+Z<TODO - Example.>
=head3 write_history
@@ -3494,13 +3494,13 @@ Dissociating the input and display cursors introduced a lot of code.
Much of this code was thrown in hastily, and things can probably be
done with less work.
-TODO: Apply some thought to what's already been done.
+Z<TODO: Apply some thought to what's already been done.>
-TODO: Ensure that the screen updates as quickly as possible,
+Z<TODO: Ensure that the screen updates as quickly as possible,
especially on slow systems. Do little or no calculation during
displaying; either put it all before or after the display. Do it
consistently for each handled keystroke, so that certain pairs of
-editing commands don't have extra perceived latency.
+editing commands don't have extra perceived latency.>
=head2 Unimplemented Features
View
44 lib/POE/Wheel/ReadWrite.pm
@@ -774,7 +774,7 @@ L<POE::Driver::SysRW>, which implements sysread() and syswrite(), is the
default. It's used in nearly all cases, so there's no point in
specifying it.
-TODO - Example.
+Z<TODO - Example.>
=head4 Filter
@@ -783,14 +783,14 @@ input data and the serializer it uses to prepare data for writing. It
defaults to a new L<POE::Filter::Line> instance since many network
protocols are line based.
-TODO - Example.
+Z<TODO - Example.>
=head4 InputFilter
InputFilter and OutputFilter may be used to specify different filters
for input and output.
-TODO - Example.
+Z<TODO - Example.>
=head4 OutputFilter
@@ -942,7 +942,7 @@ HighEvent and LowEvent are used along with HighMark and LowMark to
control the flow of streamed output. Please see L</HighEvent> for
more information and examples.
-TODO - Example here.
+Z<TODO - Example here.>
=head2 put RECORDS
@@ -971,7 +971,7 @@ generates the event. So for example, stopping InputEvent will also
stop reading from the filehandle. L</pause_input> and
L</resume_input> may be a better way to manage input events, however.
-TODO - Example.
+Z<TODO - Example.>
=head2 set_filter POE_FILTER
@@ -988,22 +988,22 @@ Switching filters can be tricky. Please see the discussion of
get_pending() in L<POE::Filter>. Some filters may not support being
dynamically loaded or unloaded.
-TODO - Example.
+Z<TODO - Example.>
=head2 set_input_filter POE_FILTER
set_input_filter() changes a POE::Wheel::ReadWrite object's input
filter while leaving the output filter unchanged. This alters the way
data is parsed without affecting how it's serialized for output.
-TODO - Example.
+Z<TODO - Example.>
=head2 set_output_filter POE_FILTER
set_output_filter() changes how a POE::Wheel::ReadWrite object
serializes its output but does not affect the way data is parsed.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_input_filter
@@ -1014,7 +1014,7 @@ object may be introspected or altered via its own methods.
There is no get_filter() method because there is no sane return value
when input and output filters differ.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_output_filter
@@ -1025,7 +1025,7 @@ object may be introspected or altered via its own methods.
There is no get_filter() method because there is no sane return value
when input and output filters differ.
-TODO - Example.
+Z<TODO - Example.>
=head2 set_high_mark HIGH_MARK_OCTETS
@@ -1038,7 +1038,7 @@ greater than HIGH_MARK_OCTETS.
Both HighEvent and put() indicate that it's unsafe to continue writing
when the output buffer expands to at least HIGH_MARK_OCTETS.
-TODO - Example.
+Z<TODO - Example.>
=head2 set_low_mark LOW_MARK_OCTETS
@@ -1050,7 +1050,7 @@ POE::Wheel::ReadWrite objects will emit a LowEvent when their output
buffers shrink to LOW_MARK_OCTETS after having reached
HIGH_MARK_OCTETS.
-TODO - Example.
+Z<TODO - Example.>
=head2 ID
@@ -1060,7 +1060,7 @@ stashed by its ID. Events generated by the POE::Wheel::ReadWrite
object will include the ID of the object, so that they may be matched
back to their sources.
-TODO - Example.
+Z<TODO - Example.>
=head2 pause_input
@@ -1069,7 +1069,7 @@ watching for input, and thus stop emitting InputEvent events. It's
much more efficient than destroying the object outright, especially if
an application intends to resume_input() later.
-TODO - Example.
+Z<TODO - Example.>
=head2 resume_input
@@ -1078,7 +1078,7 @@ back on. It's used to resume watching for input, and thus resume
sending InputEvent events. pause_input() and resume_input() implement
a form of input flow control, driven by the application itself.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_input_handle
@@ -1088,7 +1088,7 @@ Manipulating filehandles that are managed by POE may cause nasty side
effects, which may change from one POE release to the next. Please
use caution.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_output_handle
@@ -1098,7 +1098,7 @@ Manipulating filehandles that are managed by POE may cause nasty side
effects, which may change from one POE release to the next. Please
use caution.
-TODO - Example.
+Z<TODO - Example.>
=head2 shutdown_input
@@ -1110,7 +1110,7 @@ Occasionally, the POE::Wheel::ReadWrite object will stop monitoring
its input filehandle for new data. This occurs regardless of the
filehandle type.
-TODO - Example.
+Z<TODO - Example.>
=head2 shutdown_output
@@ -1122,15 +1122,15 @@ Occasionally, the POE::Wheel::ReadWrite object will stop monitoring its
output filehandle for new data. This occurs regardless of the
filehandle type.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_driver_out_octets
L<POE::Driver> objects contain output buffers that are flushed
asynchronously. get_driver_out_octets() returns the number of octets
remaining in the wheel's driver's output buffer.
-TODO - Example.
+Z<TODO - Example.>
=head2 get_driver_out_messages
@@ -1142,7 +1142,7 @@ Stream-based drivers will simply return 1 if any data remains to be
flushed. This is because they operate with one potentially large
message.
-TODO - Example.
+Z<TODO - Example.>
=head2 flush
@@ -1165,7 +1165,7 @@ It should be obvious by now that B<this method is experimental>. Its
behavior may change or it may disappear outright. Please let us know
whether it's useful.
-# TODO - Example?
+Z<TODO - Example?>
=head1 SEE ALSO
View
2 lib/POE/Wheel/Run.pm
@@ -1500,7 +1500,7 @@ from STDOUT.
The L<IO::Pty> module is only loaded if "pty" or "pty-pipe" is used.
It's not a dependency until it's actually needed.
-TODO - Example.
+Z<TODO - Example.>
=head4 Winsize
View
26 lib/POE/Wheel/SocketFactory.pm
@@ -1238,15 +1238,15 @@ should not attempt to use IPv6 until someone contributes a workaround.
IPv6 support requires a 21st century Socket module and the presence of
Socket::GetAddrInfo to resolve host names to IPv6 addresses.
-TODO - Example.
+Z<TODO - Example.>
=head4 SocketType
C<SocketType> supplies the socket() call with a particular socket
type, which may be C<SOCK_STREAM> or C<SOCK_DGRAM>. C<SOCK_STREAM> is
the default if C<SocketType> is not supplied.
-TODO - Example.
+Z<TODO - Example.>
=head4 SocketProtocol
@@ -1257,7 +1257,7 @@ domain sockets.
The protocol defaults to "tcp" for INET domain sockets. There is no
default for other socket domains.
-TODO - Example.
+Z<TODO - Example.>
=head3 Setting Socket Options
@@ -1306,7 +1306,7 @@ contain a path describing the socket's filename. This is required for
server sockets and datagram client sockets. C<BindAddress> has no
default value for UNIX sockets.
-TODO - Example.
+Z<TODO - Example.>
=head4 BindPort
@@ -1318,7 +1318,7 @@ choose an indeterminate unallocated port.
C<BindPort> may be a port number or a name that can be looked up in
the system's services (or equivalent) database.
-TODO - Example.
+Z<TODO - Example.>
=head3 Connectionless Sockets
@@ -1327,7 +1327,7 @@ needing to listen() for connections or connect() to remote addresses.
This class of sockets is complete after the bind() call.
-TODO - Example.
+Z<TODO - Example.>
=head3 Connecting the Socket to a Remote Endpoint
@@ -1358,7 +1358,7 @@ Internet address, or a UNIX socket path. It will be packed, with or
without an accompanying C<RemotePort>, as necessary for the socket
domain.
-TODO - Example.
+Z<TODO - Example.>
=head4 RemotePort
@@ -1369,7 +1369,7 @@ contain both an address and a port.
The remote port may be numeric, or it may be a symbolic name found in
/etc/services or the equivalent for your operating system.
-TODO - Example.
+Z<TODO - Example.>
=head3 Listening for Connections
@@ -1389,7 +1389,7 @@ than C<SOMAXCONN> will be clipped to C<SOMAXCONN>. Excessively large
C<ListenQueue> values are not necessarily portable, and may cause
errors in some rare cases.
-TODO - Example.
+Z<TODO - Example.>
=head3 Emitting Events
@@ -1429,7 +1429,7 @@ disable those events.
event() is described in more depth in L<POE::Wheel>.
-TODO - Example.
+Z<TODO - Example.>
=head2 getsockname
@@ -1443,15 +1443,15 @@ to which POE::Wheel::SocketFactory has bound its listening socket.
Test applications may use getsockname() to find the server socket
after POE::Wheel::SocketFactory has bound to INADDR_ANY port 0.
-TODO - Example.
+Z<TODO - Example.>
=head2 ID
ID() returns the wheel's unique ID. The ID will also be included in
every event the wheel generates. Applications can match events back
to the objects that generated them.
-TODO - Example.
+Z<TODO - Example.>
=head2 pause_accept
@@ -1468,7 +1468,7 @@ pause_accept() and resume_accept() is quicker and more reliable than
dynamically destroying and re-creating a POE::Wheel::SocketFactory
object.
-TODO - Example.
+Z<TODO - Example.>
=head2 resume_accept

0 comments on commit 5c2367d

Please sign in to comment.