Permalink
Browse files

added POD descriptions of methods

  • Loading branch information...
1 parent bdadbd8 commit 82f05fdcdf120e5b66ac7e6b6d4e91955c432162 @barbie committed Nov 5, 2009
Showing with 76 additions and 0 deletions.
  1. +1 −0 CHANGES
  2. +75 −0 lib/CPAN/Testers/Data/Uploads.pm
View
@@ -4,6 +4,7 @@ Revision history for Perl distribution CPAN-Testers-Data-Uploads
0.12 05/11/2009
- added fast reindex functionality
- improved speed of index lookup
+ - added more POD descriptions of methods.
0.11 02/11/2009
- update to logging messages
@@ -535,18 +535,84 @@ Instatiates the object CPAN::Testers::Data::Uploads:
=item * process
+Based on accessor settings will run the appropriate methods for the current
+execution.
+
=item * generate
+Generates a new uploads and ixlatest database.
+
=item * reindex
+Rebuilds the ixlatest table for all entries.
+
=item * reindex_fast
+Updates the ixlatest tables for any entries that have had a more recent upload.
+
=item * update
+Updates the uploads and ixlatest databases.
+
=item * backup
+Provides backup files of the uploads database.
+
=item * help
+Provides a help screen.
+
+=back
+
+=head2 Accessor Methods
+
+=over
+
+=item * uploads
+
+Database handle to the uploads database.
+
+=item * backpan
+
+Path to the BACKPAN archive directory.
+
+=item * cpan
+
+Path to the CPAN archive directory.
+
+=item * logfile
+
+Path to output log file for progress and debugging messages.
+
+=item * logclean
+
+If set to a true value will create/overwrite the logfile, otherwise will
+append any messages.
+
+=item * lastfile
+
+Path to the file containing the last NNTPID processed.
+
+=item * mgenerate
+
+If set to a true value runs in generate mode for the process method().
+
+=item * mupdate
+
+If set to a true value runs in update mode for the process method().
+
+=item * mbackup
+
+If set to a true value runs in backup mode for the process method().
+
+=item * mreindex
+
+If set to a true value runs in reindex mode for the process method().
+
+=item * mfast
+
+If set to a true value runs in fast reindex mode for the process method().
+
=back
=head2 Private Methods
@@ -555,16 +621,25 @@ Instatiates the object CPAN::Testers::Data::Uploads:
=item * _parse_archive
+Parses the given article from the NNTP feed.
+
=item * _update_index
+Updates the ixlatest table and pushes requests to the page_request table.
+
=item * _nntp_connect
Sets up the connection to the NNTP server.
=item * _lastid
+Sets or returns the last NNTPID processed.
+
=item * _init_options
+Initialises internal configuration settings based on command line options, API
+options and configuration file settings.
+
=back
=head1 BECOME A TESTER

0 comments on commit 82f05fd

Please sign in to comment.