[Bps-public-commit] r13687 - CPAN2RT/lib

[ruz at bestpractical.com]

Author: ruz
Date: Mon Jun 30 08:42:31 2008
New Revision: 13687

Modified:
   CPAN2RT/lib/CPAN2RT.pm

Log:
* pod update

Modified: CPAN2RT/lib/CPAN2RT.pm
==============================================================================
--- CPAN2RT/lib/CPAN2RT.pm	(original)
+++ CPAN2RT/lib/CPAN2RT.pm	Mon Jun 30 08:42:31 2008
@@ -28,6 +28,28 @@
 our $DEBUG = 0;
 sub debug(&);
 
+=head1 METHODS
+
+=head2 new
+
+Simple constructor that creates a hash based object and stores all
+passed arguments inside it. Then L</init> is called.
+
+=head3 options
+
+=over 8
+
+=item home - RT home dir, RTHOME is checked if empty and defaults to
+"/opt/rt3".
+
+=item debug - turn on ddebug output to STDERR.
+
+=item mirror - CPAN mirror to fetch files from.
+
+=back
+
+=cut
+
 sub new {
     my $proto = shift;
     my $self = bless { @_ }, ref($proto) || $proto;
@@ -35,6 +57,14 @@
     return $self;
 }
 
+=head2 init
+
+Called right after constructor, changes @INC, loads RT and initilize it.
+
+See options in description of L</new>.
+
+=cut
+
 sub init {
     my $self = shift;