[icinga-checkins] icinga.org: icinga-reports/mluebben/default: Cleanup documentation

git at icinga.org git at icinga.org
Thu Jul 7 09:38:58 CEST 2011


Module: icinga-reports
Branch: mluebben/default
Commit: 1d7bb3f3d1f29df3a7d6285400850390ac1906b2
URL:    https://git.icinga.org/?p=icinga-reports.git;a=commit;h=1d7bb3f3d1f29df3a7d6285400850390ac1906b2

Author: Michael Luebben <mluebben at destiny.(none)>
Date:   Thu Jul  7 09:38:47 2011 +0200

Cleanup documentation

---

 AvailReportParser/Modules/Database/DBHandler.pm  |    6 +++---
 AvailReportParser/Modules/Parser/Availability.pm |    2 +-
 AvailReportParser/importAvailReport.pl           |    4 ++--
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/AvailReportParser/Modules/Database/DBHandler.pm b/AvailReportParser/Modules/Database/DBHandler.pm
index 585e8df..2d866d6 100755
--- a/AvailReportParser/Modules/Database/DBHandler.pm
+++ b/AvailReportParser/Modules/Database/DBHandler.pm
@@ -149,7 +149,7 @@ Finishes report after parsing
 
 =head2 EXAMPLE
 
-  $reportID = $DBHandler->createNewReport();
+  $reportID = $DBHandler->finishReport("1", "0.13388991355896", "0", "Report successfully created with ID 1");
 
 =cut
 sub finishReport {
@@ -502,7 +502,7 @@ Close database connection
 
 =head2 EXAMPLE
 
-  $DBHandler->close
+  $DBHandler->close()
 
 =cut
 sub close {
@@ -526,7 +526,7 @@ Returns error message from object
 
 =head2 EXAMPLE
 
-  $Avail->getErrorMessage
+  $DBHandler->getErrorMessage()
 
 =cut
 sub getErrorMessage {
diff --git a/AvailReportParser/Modules/Parser/Availability.pm b/AvailReportParser/Modules/Parser/Availability.pm
index 5885615..41eb94f 100755
--- a/AvailReportParser/Modules/Parser/Availability.pm
+++ b/AvailReportParser/Modules/Parser/Availability.pm
@@ -21,7 +21,7 @@ Version 0.1.1
 
 =head1 DESCRIPTION
 
-This module get and parse the availalibilty report only for a service from Icinga/Nagios.
+This module get and parse the availalibilty report for a host or service from Icinga/Nagios.
 
 =head1 SYNOPSIS
 
diff --git a/AvailReportParser/importAvailReport.pl b/AvailReportParser/importAvailReport.pl
index 022d90b..69613f3 100755
--- a/AvailReportParser/importAvailReport.pl
+++ b/AvailReportParser/importAvailReport.pl
@@ -22,7 +22,7 @@ Version 0.1.9
 
  Hostname from configured host in Icinga/Nagios
  
-=item -S <service> (required)
+=item -S <service> (optional)
 
  Service description from configured service in Icinga/Nagios
  
@@ -382,7 +382,7 @@ if ($parseResult == -1) {
 			my $purpleUnscheduledTimeMinutes = $ReportAvail->getParsedBreakdownValue($stateDefinition,"unscheduled","time","minutes");
 			my $purpleUnscheduledTimeSeconds = $ReportAvail->getParsedBreakdownValue($stateDefinition,"unscheduled","time","seconds");
 			$DBHandler->insertAvailBreakdown($reportID, $stateDefinition, "unscheduled", "time", $purpleUnscheduledTimeDays, $purpleUnscheduledTimeHours, $purpleUnscheduledTimeMinutes, $purpleUnscheduledTimeSeconds);
-			
+
 			# Scheduled
 			my $purpleScheduledTimeDays = $ReportAvail->getParsedBreakdownValue($stateDefinition,"scheduled","time","days");
 			my $purpleScheduledTimeHours = $ReportAvail->getParsedBreakdownValue($stateDefinition,"scheduled","time","hours");





More information about the icinga-checkins mailing list