svn commit: rev 36758 - spamassassin/trunk/lib/Mail/SpamAssassin

[jm...@apache.org]

Author: jm
Date: Sun Aug 22 22:48:40 2004
New Revision: 36758

Modified:
   spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
Log:
doco fix: simplify sample plugin text a little

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm	(original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm	Sun Aug 22 22:48:40 2004
@@ -20,22 +20,26 @@
 
 =head1 SYNOPSIS
 
+=head2 SpamAssassin configuration:
+
+  loadplugin MyPlugin /path/to/myplugin.pm
+
+=head2 Perl code:
+
   package MyPlugin;
 
   use Mail::SpamAssassin::Plugin;
-  use vars qw(@ISA);
-  @ISA = qw(Mail::SpamAssassin::Plugin);
+  our @ISA = qw(Mail::SpamAssassin::Plugin);
 
   sub new {
-    my $class = shift;
-    my $mailsaobject = shift;
+    my ($class, $mailsa) = @_;
     
     # the usual perlobj boilerplate to create a subclass object
     $class = ref($class) || $class;
     my $self = $class->SUPER::new($mailsaobject);
     bless ($self, $class);
    
-    # then register an eval rule
+    # then register an eval rule, if desired...
     $self->register_eval_rule ("check_for_foo");
 
     # and return the new plugin object