further detail OR->connect arguments, and document other bits
[scpubgit/Object-Remote.git] / lib / Object / Remote / Connector / Local.pm
index 838bd5d..f43cfe3 100644 (file)
@@ -10,9 +10,25 @@ BEGIN {  }
 
 push @Object::Remote::Connection::Guess, sub {
   if (($_[0]||'') eq '-') {
-      shift(@_); 
-      __PACKAGE__->new(@_); 
+      shift(@_);
+      __PACKAGE__->new(@_);
   }
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::Local - A connector for a local Perl process
+
+=head1 DESCRIPTION
+
+Used to create a connector that talks to a Perl process started on the local
+machine. Invoked by L<Object::Remote/connect> if the connection spec is C<->.
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector::PerlInterpreter> and
+provides no own arguments.
+
+=cut