- From: Olivier Thereaux <ot@dev.w3.org>
- Date: Tue, 07 Sep 2004 02:04:38 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/perl/modules/W3C/LogValidator/lib/W3C
In directory hutz:/tmp/cvs-serv4721
Modified Files:
LogValidator.pm
Log Message:
API documentation
Index: LogValidator.pm
===================================================================
RCS file: /sources/public/perl/modules/W3C/LogValidator/lib/W3C/LogValidator.pm,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- LogValidator.pm 12 Aug 2004 02:28:51 -0000 1.10
+++ LogValidator.pm 7 Sep 2004 02:04:36 -0000 1.11
@@ -397,8 +397,12 @@
As an easy alternative to using this module, the perl script logprocess.pl is bundled in the W3C::LogValidator distribution.
+=head1 API
+
+=head2 Constructor
=over 2
+
=item $processor = W3C::LogValidator->new
Constructs a new C<W3C::LogValidator> processor. You might pass a configuration file name,
@@ -428,6 +432,8 @@
=back
+=head2 Main processing method
+
=over 4
=item $processor->process
@@ -435,10 +441,26 @@
Do-it-all method:
Read configuration file (if any), parse log files, run them through processing modules, send result to output module.
+=back
+
+=head2 Modules methods
+
+=over 4
+
=item $processor->config_module
Creates a configuration hash for a specific module, adding module-specific configuration variables, overriding if necessary
+=item $processor->use_modules
+
+Run the data parsed off the log files through the various processing (validation) modules specified by UseValidationModule in the configuration.
+
+=back
+
+=head2 Log parsing and URI methods
+
+=over 4
+
=item $processor->read_logfiles
Loops through and parses all log files specified in the configuration
@@ -472,10 +494,6 @@
Returns the number of hits for a given URI.
Basically a "public" method accessing $hits{$uri};
-=item $processor->use_modules
-
-Run the data parsed off the log files through the various processing (validation) modules specified by UseValidationModule in the configuration.
-
=back
=head1 BUGS
Received on Tuesday, 7 September 2004 02:04:39 UTC