From 563e3101d9499777dec2941b23fc3a2609216846 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Mon, 11 Feb 2008 21:44:09 +0000 Subject: [PATCH] added POD to the macro skeleton --- lib/WebGUI/Macro/_macro.skeleton | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/lib/WebGUI/Macro/_macro.skeleton b/lib/WebGUI/Macro/_macro.skeleton index 010a22a93..21879a64a 100644 --- a/lib/WebGUI/Macro/_macro.skeleton +++ b/lib/WebGUI/Macro/_macro.skeleton @@ -12,6 +12,34 @@ package WebGUI::Macro::MacroSkeleton; # edit this line to match your own macro n use strict; +=head1 NAME + +Package WebGUI::Macro::MacroSkeleton + +=head1 DESCRIPTION + +Handy example code for starting a new Macro when you have to start from scratch. + +=head2 process( $session, [@other_options] ) + +The main macro class, Macro.pm, will call this subroutine and pass it + +=over 4 + +=item * + +A session variable + +=item * + +Any other options that were sent to the macro by the user. It is up to you to set defaults and +to validate user input. + +=back + +=cut + + #------------------------------------------------------------------- sub process { my $session = shift;