[poe-commits] SF.net SVN: poe: [2225] trunk/poe/lib/POE.pm
Brought to you by:
rcaputo
From: <rc...@us...> - 2007-08-19 18:16:00
|
Revision: 2225 http://poe.svn.sourceforge.net/poe/?rev=2225&view=rev Author: rcaputo Date: 2007-08-19 11:15:59 -0700 (Sun, 19 Aug 2007) Log Message: ----------- Move the POE.pm use lines to POE::Kernel. Mark that contributors need to be documented. Modified Paths: -------------- trunk/poe/lib/POE.pm Modified: trunk/poe/lib/POE.pm =================================================================== --- trunk/poe/lib/POE.pm 2007-08-19 13:42:54 UTC (rev 2224) +++ trunk/poe/lib/POE.pm 2007-08-19 18:15:59 UTC (rev 2225) @@ -219,28 +219,6 @@ another POE::Resource class. One can then expose the functionality with a new POE::API mix-in. -=head1 USING POE - -POE's C<import> method implements some magic to cut down on the amount -of necessary setup. - -For starters, C<use POE> will automatically include POE::Kernel. And -it will also include POE::Session if a session type isn't specified. -Most programs need both of these modules, so POE gives you them for -free. - -Modules can also be included on the C<use POE> line. The leading -"POE::" should be omitted when using POE this way: - - use POE qw(Component::Client::TCP). - -This is a somewhat abbreviated version of: - - use POE; - use POE::Kernel; - use POE::Session; - use POE::Component::Client::TCP; - =head1 DOCUMENTATION ROADMAP You're reading the main POE documentation. It's the general entry @@ -255,6 +233,12 @@ sometimes they are divided among classes that share in their implementation. +=head2 Basic Usage + +Basic usage, even for POE.pm, is documented in POE::Kernel. That's +where most of POE's work is done, and POE.pm is little more than a +class loader. + =head2 @_[KERNEL, HEAP, etc.] Event handler calling conventions, that weird C<@_[KERNEL, HEAP]> @@ -643,6 +627,9 @@ 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. + =back =head2 Author This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |