From 7b700d0ca59da659d6297aa04b667862b17f4be0 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Mon, 31 Jan 2011 19:25:50 -0800 Subject: [PATCH] Add POD for WebGUI::ICal --- lib/WebGUI/ICal.pm | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/lib/WebGUI/ICal.pm b/lib/WebGUI/ICal.pm index bf2291d23..a7331d555 100644 --- a/lib/WebGUI/ICal.pm +++ b/lib/WebGUI/ICal.pm @@ -1,8 +1,41 @@ package WebGUI::ICal; +=head1 LEGAL + + ------------------------------------------------------------------- + WebGUI is Copyright 2001-2009 Plain Black Corporation. + ------------------------------------------------------------------- + Please read the legal notices (docs/legal.txt) and the license + (docs/license.txt) that came with this distribution before using + this software. + ------------------------------------------------------------------- + http://www.plainblack.com info@plainblack.com + ------------------------------------------------------------------- + +=head1 NAME + +Package WebGUI::ICal + +=head1 DESCRIPTION + +This package wraps Data::ICal so the PRODUCT_ID parameter in the generated iCal feeds are set appropriately. + +=head1 SYNOPSIS + + use WebGUI::ICal; + +=cut + + use WebGUI; use parent qw/Data::ICal/; +=head2 product_id + +Override the method from Data::ICal to set it to be the WebGUI version and status. + +=cut + sub product_id { return 'WebGUI '. $WebGUI::VERSION . '-' . $WebGUI::STATUS; }