[COMMIT LOGREPORT] service/all/lib/Lire ReportConfig.pm,1.35,1.36
Joost van Baal
vanbaal at users.sourceforge.net
Sun Jul 16 12:05:57 CEST 2006
Update of /cvsroot/logreport/service/all/lib/Lire
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv12550
Modified Files:
ReportConfig.pm
Log Message:
fix some typos in manpage
Index: ReportConfig.pm
===================================================================
RCS file: /cvsroot/logreport/service/all/lib/Lire/ReportConfig.pm,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- ReportConfig.pm 25 Jul 2005 15:03:48 -0000 1.35
+++ ReportConfig.pm 16 Jul 2006 10:05:55 -0000 1.36
@@ -24,7 +24,7 @@
=head1 NAME
-Lire::ReportConfig - API to report configuration file
+Lire::ReportConfig - API to the report configuration file
=head1 SYNOPSIS
@@ -38,9 +38,9 @@
=head1 DESCRIPTION
-This class represent report configuration. Report configuration are
-stored as XML configuration using the Lire::Report::ReportSpec
-configuraiton type.
+This class represents report configurations. Report configurations are
+stored as an XML configuration using the Lire::Report::ReportSpec
+configuration type.
=head1 TEMPLATES
@@ -51,7 +51,7 @@
=head2 templates()
Returns an array reference containing the names of all defined
-templates.
+templates.
=cut
@@ -215,7 +215,7 @@
=head2 title( [ $new_title ] )
-Returns (and optionnally change) the title that will be assigned to
+Returns (and optionnally changes) the title that will be assigned to
the report.
=cut
@@ -427,7 +427,7 @@
=head2 sections()
Return's this report configuration's sections as an array of
-Lire::Section objects
+Lire::Section objects.
=cut
@@ -581,7 +581,8 @@
The $timespan_start and $timespan_end attribute will be used to initiate
the Report object.
-Called in lr_dlf2xml(1) and lr_xml_merge(1).
+Used when generating an XML report from a DLF source, and
+when merging XML reports.
=cut
@@ -605,7 +606,7 @@
=head2 create_analyser_streams( $store )
This method will make sure that a DlfStream is available in the
-Lire::DlfStore $store for each schemas used by this report
+Lire::DlfStore $store for each schema used by this report
configuration. The stream will be created by running the first
analyser which is able to generate the schema using exising streams.
@@ -646,8 +647,8 @@
=head2 generate_report( $store )
- Generates from this report configuration a Lire::Report. The report is
- computed using the streams in the Lire::DlfStore $store.
+Generates a Lire::Report from this report configuration. The report is
+computed using the streams in the Lire::DlfStore $store.
=cut
@@ -830,8 +831,8 @@
=head1 SEE ALSO
- Lire::ReportSection(3pm), Lire::ReportSpec(3pm),
- Lire::FilterSpec(3pm) Lire::Report(3pm)
+Lire::ReportSection(3pm), Lire::ReportSpec(3pm),
+Lire::FilterSpec(3pm) Lire::Report(3pm)
=head1 AUTHOR
--
To UNSUBSCRIBE, email to commit-request at logreport.org with a subject of
"unsubscribe". Trouble? Send an email with subject "help" to
commit-request at logreport.org
More information about the Commit
mailing list