[poe-commits] poe POE.pm,1.160,1.161

[<rc...@us...>]

Update of /cvsroot/poe/poe
In directory sc8-pr-cvs1:/tmp/cvs-serv30053

Modified Files:
	POE.pm 
Log Message:
Applied Rich Morin's documentation edits.


Index: POE.pm
===================================================================
RCS file: /cvsroot/poe/poe/POE.pm,v
retrieving revision 1.160
retrieving revision 1.161
diff -C2 -d -r1.160 -r1.161
*** POE.pm	9 Jun 2003 16:02:41 -0000	1.160
--- POE.pm	16 Jul 2003 06:34:46 -0000	1.161
***************
*** 59,63 ****
  =head1 NAME
  
! POE - multitasking and networking framework for perl
  
  =head1 SYNOPSIS
--- 59,63 ----
  =head1 NAME
  
! POE - multitasking and networking framework for Perl
  
  =head1 SYNOPSIS
***************
*** 120,125 ****
  POE is an acronym of "Perl Object Environment".  It originally was
  designed as the core of a persistent object server and runtime
! environment, but it's evolved into a general purpose multitasking and
! networking framework.
  
  POE's core contains two types of modules.  First there's POE::Kernel;
--- 120,125 ----
  POE is an acronym of "Perl Object Environment".  It originally was
  designed as the core of a persistent object server and runtime
! environment, but it has evolved into a general purpose multitasking
! and networking framework.
  
  POE's core contains two types of modules.  First there's POE::Kernel;
***************
*** 191,198 ****
  =item Start initial sessions or machines
  
! The Kernel only runs as long as there is something for it to do.  It's
  main loop returns after the last session has stopped.  The obvious
! corolary to this rule is that the main loop will return immediately if
! nothing is set up when it's called.
  
    for (0..9) {
--- 191,198 ----
  =item Start initial sessions or machines
  
! The Kernel only runs as long as there is something for it to do.  Its
  main loop returns after the last session has stopped.  The obvious
! corollary to this rule is that the main loop will return immediately
! if nothing is set up when it's called.
  
    for (0..9) {
***************
*** 229,235 ****
  
  The events layer consists of an event dispatcher, POE::Kernel, and the
! sessions or state machines it runs: POE::Session (a generic event
! driven thread) and POE::NFA (an event driven nondeterministic finite
! automaton).
  
  =item One or more I/O layers
--- 229,235 ----
  
  The events layer consists of an event dispatcher, POE::Kernel, and the
! sessions or state machines it runs: POE::Session (a generic,
! event-driven thread) and POE::NFA (an event-driven non-deterministic
! finite automaton).
  
  =item One or more I/O layers
***************
*** 248,252 ****
  The Curses wheel handles non-blocking input for programs using the
  curses text interface.  It requires the Curses perl module and a
! familiarity with curses programming.q
  
  =item POE::Wheel::FollowTail
--- 248,252 ----
  The Curses wheel handles non-blocking input for programs using the
  curses text interface.  It requires the Curses perl module and a
! familiarity with curses programming.
  
  =item POE::Wheel::FollowTail
***************
*** 286,295 ****
  =item POE::Driver::SysRW
  
! Nobody has needed another driver yet, so this is the only one
  currently available.  It performs sysread and syswrite in a generic
! way so that ReadWrite can use it and future drivers interchangeably.
  
! Other drivers will use the same interface, should they ever be
! written.
  
  =back
--- 286,295 ----
  =item POE::Driver::SysRW
  
! Nobody has needed another driver yet, so this is the only one that is
  currently available.  It performs sysread and syswrite in a generic
! way, so that ReadWrite can use it and future drivers interchangeably.
  
! Other drivers, should they ever be written, will use the same
! interface.
  
  =back
***************
*** 384,389 ****
  Finally, there are some files which POE uses but aren't required
  elsewhere.  These include POE::Preprocessor and the base classes:
! POE::Component, POE::Driver, POE::Filter and POE::Wheel.  There also
! are some development files in the lib directory.
  
  =over 2
--- 384,389 ----
  Finally, there are some files which POE uses but aren't required
  elsewhere.  These include POE::Preprocessor and the base classes:
! POE::Component, POE::Driver, POE::Filter and POE::Wheel.  In addition,
! there are some development files in the lib directory.
  
  =over 2
***************
*** 736,745 ****
  the hope that one of them will work on any given platform.  It's
  preferred over two OneWay pipes because sometimes two-way transports
! are available and it can save you a couple filehandles.
  
  =item POE::Preprocessor
  
  POE's preprocessor covers inline constant replacement, enumerated
! constants, and macro substitutions in perl programs.
  
  =back
--- 736,745 ----
  the hope that one of them will work on any given platform.  It's
  preferred over two OneWay pipes because sometimes two-way transports
! are available and it can save you a couple of filehandles.
  
  =item POE::Preprocessor
  
  POE's preprocessor covers inline constant replacement, enumerated
! constants, and macro substitutions in Perl programs.
  
  =back
***************
*** 789,793 ****
  ambassador, or something, between Rocco's point of view and people who
  haven't had the benefit of knowing the system since its conception.
! He's spearheaded the movement to smiplify POE for new users,
  flattening the learning curve and making the system more accessible to
  everyone.  He's almost singlehandedly rewriting POE's documentation.
--- 789,793 ----
  ambassador, or something, between Rocco's point of view and people who
  haven't had the benefit of knowing the system since its conception.
! He's spearheaded the movement to simplify POE for new users,
  flattening the learning curve and making the system more accessible to
  everyone.  He's almost singlehandedly rewriting POE's documentation.