Author: jm
Date: Tue Jul 12 17:59:26 2005
New Revision: 216068
URL: http://svn.apache.org/viewcvs?rev=216068&view=rev
Log:
bug 4465: fix formatting in POD docs
Modified:
spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm
spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm
spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm Tue Jul 12 17:59:26 2005
@@ -280,3 +280,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::Bayes - determine spammishness using a Bayesian classifier
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is a Bayesian-like form of probability-analysis classification, using an
@@ -1411,3 +1409,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::BayesStore - Bayesian Storage Module
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is the public API for the Bayesian store methods. Any implementation of
@@ -34,9 +32,14 @@
use bytes;
use Mail::SpamAssassin::Logger;
+# TODO: if we ever get tuits, it'd be good to make these POD
+# method docs more perlish... hardly a biggie.
+
=head1 METHODS
-=head2 new
+=over 4
+
+=item new
public class (Mail::SpamAssassin::BayesStore) new (Mail::SpamAssassin::Bayes $bayes)
@@ -63,7 +66,7 @@
$self;
}
-=head2 DB_VERSION
+=item DB_VERSION
public instance (Integer) DB_VERSION ()
@@ -78,7 +81,7 @@
return $self->{supported_db_version};
}
-=head2 read_db_configs
+=item read_db_configs
public instance () read_db_configs ()
@@ -112,7 +115,7 @@
$self->{bayes}->read_db_configs();
}
-=head2 tie_db_readonly
+=item tie_db_readonly
public instance (Boolean) tie_db_readonly ()
@@ -126,7 +129,7 @@
die "bayes: tie_db_readonly: not implemented\n";
}
-=head2 tie_db_writable
+=item tie_db_writable
public instance (Boolean) tie_db_writable ()
@@ -143,7 +146,7 @@
die "bayes: tie_db_writable: not implemented\n";
}
-=head2 untie_db
+=item untie_db
public instance () untie_db ()
@@ -157,7 +160,7 @@
die "bayes: untie_db: not implemented\n";
}
-=head2 calculate_expire_delta
+=item calculate_expire_delta
public instance (%) calculate_expire_delta (Integer $newest_atime,
Integer $start,
@@ -174,7 +177,7 @@
die "bayes: calculate_expire_delta: not implemented\n";
}
-=head2 token_expiration
+=item token_expiration
public instance (Integer, Integer,
Integer, Integer) token_expiration(\% $opts,
@@ -192,7 +195,7 @@
die "bayes: token_expiration: not implemented\n";
}
-=head2 expire_old_tokens
+=item expire_old_tokens
public instance (Boolean) expire_old_tokens (\% hashref)
@@ -224,7 +227,7 @@
$ret;
}
-=head2 expire_old_tokens_trapped
+=item expire_old_tokens_trapped
public instance (Boolean) expire_old_tokens_trapped (\% $opts)
@@ -385,7 +388,7 @@
return 1;
}
-=head2 sync_due
+=item sync_due
public instance (Boolean) sync_due ()
@@ -399,7 +402,7 @@
die "bayes: sync_due: not implemented\n";
}
-=head2 expiry_due
+=item expiry_due
public instance (Boolean) expiry_due ()
@@ -450,7 +453,7 @@
return 1;
}
-=head2 seen_get
+=item seen_get
public instance (Char) seen_get (String $msgid)
@@ -466,7 +469,7 @@
die "bayes: seen_get: not implemented\n";
}
-=head2 seen_put
+=item seen_put
public instance (Boolean) seen_put (String $msgid, Char $flag)
@@ -481,7 +484,7 @@
die "bayes: seen_put: not implemented\n";
}
-=head2 seen_delete
+=item seen_delete
public instance (Boolean) seen_delete (String $msgid)
@@ -495,7 +498,7 @@
die "bayes: seen_delete: not implemented\n";
}
-=head2 get_storage_variables
+=item get_storage_variables
public instance (@) get_storage_variables ()
@@ -534,7 +537,7 @@
die "bayes: get_storage_variables: not implemented\n";
}
-=head2 dump_db_toks
+=item dump_db_toks
public instance () dump_db_toks (String $template, String $regex, @ @vars)
@@ -549,7 +552,7 @@
die "bayes: dump_db_toks: not implemented\n";
}
-=head2 set_last_expire
+=item set_last_expire
public instance (Boolean) _set_last_expire (Integer $time)
@@ -563,7 +566,7 @@
die "bayes: set_last_expire: not implemented\n";
}
-=head2 get_running_expire_tok
+=item get_running_expire_tok
public instance (Time) get_running_expire_tok ()
@@ -578,7 +581,7 @@
die "bayes: get_running_expire_tok: not implemented\n";
}
-=head2 set_running_expire_tok
+=item set_running_expire_tok
public instance (Time) set_running_expire_tok ()
@@ -592,7 +595,7 @@
die "bayes: set_running_expire_tok: not implemented\n";
}
-=head2 remove_running_expire_tok
+=item remove_running_expire_tok
public instance (Boolean) remove_running_expire_tok ()
@@ -606,7 +609,7 @@
die "bayes: remove_running_expire_tok: not implemented\n";
}
-=head2 tok_get
+=item tok_get
public instance (Integer, Integer, Time) tok_get (String $token)
@@ -621,7 +624,7 @@
die "bayes: tok_get: not implemented\n";
}
-=head2 tok_get_all
+=item tok_get_all
public instance (\@) tok_get_all (@ @tokens)
@@ -636,7 +639,7 @@
die "bayes: tok_get_all: not implemented\n";
}
-=head2 tok_count_change
+=item tok_count_change
public instance (Boolean) tok_count_change (Integer $spam_count,
Integer $ham_count,
@@ -654,7 +657,7 @@
die "bayes: tok_count_change: not implemented\n";
}
-=head2 nspam_nham_get
+=item nspam_nham_get
public instance (Integer, Integer) nspam_nham_get ()
@@ -669,7 +672,7 @@
die "bayes: nspam_nham_get: not implemented\n";
}
-=head2 nspam_nham_change
+=item nspam_nham_change
public instance (Boolean) nspam_nham_change (Integer $num_spam,
Integer $num_ham)
@@ -684,7 +687,7 @@
die "bayes: nspam_nham_change: not implemented\n";
}
-=head2 tok_touch
+=item tok_touch
public instance (Boolean) tok_touch (String $token,
Time $atime)
@@ -699,7 +702,7 @@
die "bayes: tok_touch: not implemanted\n";
}
-=head2 tok_touch_all
+=item tok_touch_all
public instance (Boolean) tok_touch_all (\@ $tokens,
Time $atime)
@@ -715,7 +718,7 @@
die "bayes: tok_touch_all: not implemanted\n";
}
-=head2 cleanup
+=item cleanup
public instance (Boolean) cleanup ()
@@ -730,7 +733,7 @@
die "bayes: cleanup: not implemented\n";
}
-=head2 get_magic_re
+=item get_magic_re
public instance get_magic_re (String)
@@ -744,7 +747,7 @@
die "bayes: get_magic_re: not implemented\n";
}
-=head2 sync
+=item sync
public instance (Boolean) sync (\% $opts)
@@ -758,7 +761,7 @@
die "bayes: sync: not implemented\n";
}
-=head2 perform_upgrade
+=item perform_upgrade
public instance (Boolean) perform_upgrade (\% $opts)
@@ -776,7 +779,7 @@
die "bayes: perform_upgrade: not implemented\n";
}
-=head2 clear_database
+=item clear_database
public instance (Boolean) clear_database ()
@@ -793,7 +796,7 @@
die "bayes: clear_database: not implemented\n";
}
-=head2 backup_database
+=item backup_database
public instance (Boolean) backup_database ()
@@ -807,7 +810,7 @@
die "bayes: backup_database: not implemented\n";
}
-=head2 restore_database
+=item restore_database
public instance (Boolean) restore_database (String $filename, Boolean $showdots)
@@ -824,7 +827,7 @@
die "bayes: restore_database: not implemented\n";
}
-=head2 db_readable
+=item db_readable
public instance (Boolean) db_readable ()
@@ -839,7 +842,7 @@
die "bayes: db_readable: not implemented\n";
}
-=head2 db_writable
+=item db_writable
public instance (Boolean) db_writable ()
@@ -858,3 +861,7 @@
sub sa_die { Mail::SpamAssassin::sa_die(@_); }
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm Tue Jul 12 17:59:26 2005
@@ -845,7 +845,11 @@
type => $CONF_TYPE_STRING
});
+=back
+
=head2 NETWORK TEST OPTIONS
+
+=over 4
=item trusted_networks ip.add.re.ss[/mask] ... (default: none)
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::DnsResolver - DNS resolution engine
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is a DNS resolution engine for SpamAssassin, implemented in order to
@@ -429,3 +427,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm Tue Jul 12 17:59:26 2005
@@ -71,7 +71,7 @@
=head1 METHODS
-=over
+=over 4
=item add_facilities(facilities)
@@ -305,3 +305,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm Tue Jul 12 17:59:26 2005
@@ -18,12 +18,20 @@
Mail::SpamAssassin::Message - decode, render, and hold an RFC-2822 message
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
-This module will encapsulate an email message and allow access to
-the various MIME message parts and message metadata.
+This module encapsulates an email message and allows access to the various MIME
+message parts and message metadata.
+
+The message structure, after initiating a parse() cycle, looks like this:
+
+ Message object, also top-level node in Message::Node tree
+ |
+ +---> Message::Node for other parts in MIME structure
+ | |---> [ more Message::Node parts ... ]
+ | [ others ... ]
+ |
+ +---> Message::Metadata object to hold metadata
=head1 PUBLIC METHODS
@@ -31,16 +39,6 @@
=cut
-# the message structure, after initiating a parse() cycle, is now:
-#
-# Message object, also top-level node in Message::Node tree
-# |
-# +---> Message::Node for other parts in MIME structure
-# | |---> [ more Message::Node parts ... ]
-# | [ others ... ]
-# |
-# +---> Message::Metadata object to hold metadata
-
package Mail::SpamAssassin::Message;
use strict;
@@ -1009,3 +1007,7 @@
# ---------------------------------------------------------------------------
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm Tue Jul 12 17:59:26 2005
@@ -158,3 +158,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm Tue Jul 12 17:59:26 2005
@@ -162,6 +162,8 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING
});
+=back
+
=head1 ADMINISTRATOR SETTINGS
These settings differ from the ones above, in that they are considered 'more
@@ -169,6 +171,8 @@
No matter what C<allow_user_rules> is set to, these can never be set from a
user's C<user_prefs> file.
+=over 4
+
=item auto_whitelist_factory module (default: Mail::SpamAssassin::DBBasedAddrList)
Select alternative whitelist factory module.
@@ -297,8 +301,6 @@
The table user auto-whitelists are stored in, for the above DSN.
-=back
-
=cut
push (@cmds, {
@@ -512,5 +514,8 @@
return $status;
}
-
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm Tue Jul 12 17:59:26 2005
@@ -80,6 +80,8 @@
The following configuration settings are used to control auto-learning:
+=over 4
+
=item bayes_auto_learn_threshold_nonspam n.nn (default: 0.1)
The score threshold below which a mail has to score, to be fed into
@@ -191,3 +193,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm Tue Jul 12 17:59:26 2005
@@ -38,8 +38,6 @@
See http://www.rhyolite.com/anti-spam/dcc/ for more information about
DCC.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::DCC;
@@ -84,6 +82,8 @@
=head1 USER OPTIONS
+=over 4
+
=item use_dcc (0|1) (default: 1)
Whether to use DCC, if it is available.
@@ -142,8 +142,12 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
+=back
+
=head1 ADMINISTRATOR OPTIONS
+=over 4
+
=item dcc_home STRING
This option tells SpamAssassin specifically where to find the dcc homedir.
@@ -634,3 +638,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm Tue Jul 12 17:59:26 2005
@@ -30,6 +30,8 @@
=cut
+=head1 USER SETTINGS
+
=over 4
=item use_hashcash { 1 | 0 } (default: 1)
@@ -329,3 +331,7 @@
############################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm Tue Jul 12 17:59:26 2005
@@ -29,8 +29,6 @@
See http://pyzor.sourceforge.net/ for more information about Pyzor.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::Pyzor;
@@ -75,6 +73,8 @@
=head1 USER OPTIONS
+=over 4
+
=item use_pyzor (0|1) (default: 1)
Whether to use Pyzor, if it is available.
@@ -117,8 +117,12 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
+=back
+
=head1 ADMINISTRATOR OPTIONS
+=over 4
+
=item pyzor_options options
Specify additional options to the pyzor(1) command. Please note that only
@@ -381,3 +385,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm Tue Jul 12 17:59:26 2005
@@ -36,6 +36,8 @@
See http://razor.sourceforge.net/ for more information about Razor.
+=head1 USER SETTINGS
+
=over 4
=cut
@@ -460,3 +462,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm Tue Jul 12 17:59:26 2005
@@ -263,3 +263,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm Tue Jul 12 17:59:26 2005
@@ -75,6 +75,10 @@
my($self, $conf) = @_;
my @cmds = ();
+=head1 USER SETTINGS
+
+=over 4
+
=item whitelist_from_spf add@ress.com
Use this to supplement the whitelist_from addresses with a check against the
@@ -451,3 +455,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm Tue Jul 12 17:59:26 2005
@@ -36,8 +36,6 @@
See http://www.spamcop.net/ for more information about SpamCop.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::SpamCop;
@@ -84,6 +82,8 @@
=head1 USER OPTIONS
+=over 4
+
=item spamcop_from_address add@ress.com (default: none)
This address is used during manual reports to SpamCop as the From:
@@ -138,8 +138,6 @@
},
});
-=over 4
-
=item spamcop_max_report_size (default: 50)
Messages larger than this size (in kilobytes) will be truncated in
@@ -293,3 +291,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm Tue Jul 12 17:59:26 2005
@@ -37,8 +37,6 @@
Note: the language cannot always be recognized with sufficient
confidence. In that case, C<UNWANTED_LANGUAGE_BODY> will not trigger.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::TextCat;
@@ -105,6 +103,8 @@
=head1 USER OPTIONS
+=over 4
+
=item ok_languages xx [ yy zz ... ] (default: all)
This option is used to specify which languages are considered okay for
@@ -297,8 +297,6 @@
Gaelic, Scottish Gaelic, Icelandic, Latin, Lithuanian, Latvian,
Rhaeto-Romance, Sanskrit, Scots, Slovenian, and Yiddish.
-=over 4
-
=cut
push (@cmds, {
@@ -531,3 +529,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm Tue Jul 12 17:59:26 2005
@@ -16,7 +16,7 @@
=head1 NAME
-Mail::SpamAssassin::Plugin::WhiteListSubject
+Mail::SpamAssassin::Plugin::WhiteListSubject - whitelist by Subject header
=head1 SYNOPSIS
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm Tue Jul 12 17:59:26 2005
@@ -1,11 +1,3 @@
-# A general class for utility functions. Please use this for
-# functions that stand alone, without requiring a $self object,
-# Portability functions especially.
-#
-# NOTE: The functions in this module are all considered private. Their API
-# may change at any point, and it's expected that they'll only be used by
-# other Mail::SpamAssassin modules.
-
# <@LICENSE>
# Copyright 2004 Apache Software Foundation
#
@@ -22,6 +14,25 @@
# limitations under the License.
# </@LICENSE>
+=head1 NAME
+
+Mail::SpamAssassin::Util - utility functions
+
+=head1 DESCRIPTION
+
+A general class for utility functions. Please use this for functions that
+stand alone, without requiring a $self object, Portability functions
+especially.
+
+NOTE: The functions in this module are to be considered private. Their API may
+change at any point, and it's expected that they'll only be used by other
+Mail::SpamAssassin modules. (TODO: we should probably revisit this if
+it's useful for plugin development.)
+
+=over 4
+
+=cut
+
package Mail::SpamAssassin::Util;
use strict;
@@ -1303,3 +1314,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Date: Tue Jul 12 17:59:26 2005
New Revision: 216068
URL: http://svn.apache.org/viewcvs?rev=216068&view=rev
Log:
bug 4465: fix formatting in POD docs
Modified:
spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm
spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm
spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/AutoWhitelist.pm Tue Jul 12 17:59:26 2005
@@ -280,3 +280,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Bayes.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::Bayes - determine spammishness using a Bayesian classifier
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is a Bayesian-like form of probability-analysis classification, using an
@@ -1411,3 +1409,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/BayesStore.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::BayesStore - Bayesian Storage Module
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is the public API for the Bayesian store methods. Any implementation of
@@ -34,9 +32,14 @@
use bytes;
use Mail::SpamAssassin::Logger;
+# TODO: if we ever get tuits, it'd be good to make these POD
+# method docs more perlish... hardly a biggie.
+
=head1 METHODS
-=head2 new
+=over 4
+
+=item new
public class (Mail::SpamAssassin::BayesStore) new (Mail::SpamAssassin::Bayes $bayes)
@@ -63,7 +66,7 @@
$self;
}
-=head2 DB_VERSION
+=item DB_VERSION
public instance (Integer) DB_VERSION ()
@@ -78,7 +81,7 @@
return $self->{supported_db_version};
}
-=head2 read_db_configs
+=item read_db_configs
public instance () read_db_configs ()
@@ -112,7 +115,7 @@
$self->{bayes}->read_db_configs();
}
-=head2 tie_db_readonly
+=item tie_db_readonly
public instance (Boolean) tie_db_readonly ()
@@ -126,7 +129,7 @@
die "bayes: tie_db_readonly: not implemented\n";
}
-=head2 tie_db_writable
+=item tie_db_writable
public instance (Boolean) tie_db_writable ()
@@ -143,7 +146,7 @@
die "bayes: tie_db_writable: not implemented\n";
}
-=head2 untie_db
+=item untie_db
public instance () untie_db ()
@@ -157,7 +160,7 @@
die "bayes: untie_db: not implemented\n";
}
-=head2 calculate_expire_delta
+=item calculate_expire_delta
public instance (%) calculate_expire_delta (Integer $newest_atime,
Integer $start,
@@ -174,7 +177,7 @@
die "bayes: calculate_expire_delta: not implemented\n";
}
-=head2 token_expiration
+=item token_expiration
public instance (Integer, Integer,
Integer, Integer) token_expiration(\% $opts,
@@ -192,7 +195,7 @@
die "bayes: token_expiration: not implemented\n";
}
-=head2 expire_old_tokens
+=item expire_old_tokens
public instance (Boolean) expire_old_tokens (\% hashref)
@@ -224,7 +227,7 @@
$ret;
}
-=head2 expire_old_tokens_trapped
+=item expire_old_tokens_trapped
public instance (Boolean) expire_old_tokens_trapped (\% $opts)
@@ -385,7 +388,7 @@
return 1;
}
-=head2 sync_due
+=item sync_due
public instance (Boolean) sync_due ()
@@ -399,7 +402,7 @@
die "bayes: sync_due: not implemented\n";
}
-=head2 expiry_due
+=item expiry_due
public instance (Boolean) expiry_due ()
@@ -450,7 +453,7 @@
return 1;
}
-=head2 seen_get
+=item seen_get
public instance (Char) seen_get (String $msgid)
@@ -466,7 +469,7 @@
die "bayes: seen_get: not implemented\n";
}
-=head2 seen_put
+=item seen_put
public instance (Boolean) seen_put (String $msgid, Char $flag)
@@ -481,7 +484,7 @@
die "bayes: seen_put: not implemented\n";
}
-=head2 seen_delete
+=item seen_delete
public instance (Boolean) seen_delete (String $msgid)
@@ -495,7 +498,7 @@
die "bayes: seen_delete: not implemented\n";
}
-=head2 get_storage_variables
+=item get_storage_variables
public instance (@) get_storage_variables ()
@@ -534,7 +537,7 @@
die "bayes: get_storage_variables: not implemented\n";
}
-=head2 dump_db_toks
+=item dump_db_toks
public instance () dump_db_toks (String $template, String $regex, @ @vars)
@@ -549,7 +552,7 @@
die "bayes: dump_db_toks: not implemented\n";
}
-=head2 set_last_expire
+=item set_last_expire
public instance (Boolean) _set_last_expire (Integer $time)
@@ -563,7 +566,7 @@
die "bayes: set_last_expire: not implemented\n";
}
-=head2 get_running_expire_tok
+=item get_running_expire_tok
public instance (Time) get_running_expire_tok ()
@@ -578,7 +581,7 @@
die "bayes: get_running_expire_tok: not implemented\n";
}
-=head2 set_running_expire_tok
+=item set_running_expire_tok
public instance (Time) set_running_expire_tok ()
@@ -592,7 +595,7 @@
die "bayes: set_running_expire_tok: not implemented\n";
}
-=head2 remove_running_expire_tok
+=item remove_running_expire_tok
public instance (Boolean) remove_running_expire_tok ()
@@ -606,7 +609,7 @@
die "bayes: remove_running_expire_tok: not implemented\n";
}
-=head2 tok_get
+=item tok_get
public instance (Integer, Integer, Time) tok_get (String $token)
@@ -621,7 +624,7 @@
die "bayes: tok_get: not implemented\n";
}
-=head2 tok_get_all
+=item tok_get_all
public instance (\@) tok_get_all (@ @tokens)
@@ -636,7 +639,7 @@
die "bayes: tok_get_all: not implemented\n";
}
-=head2 tok_count_change
+=item tok_count_change
public instance (Boolean) tok_count_change (Integer $spam_count,
Integer $ham_count,
@@ -654,7 +657,7 @@
die "bayes: tok_count_change: not implemented\n";
}
-=head2 nspam_nham_get
+=item nspam_nham_get
public instance (Integer, Integer) nspam_nham_get ()
@@ -669,7 +672,7 @@
die "bayes: nspam_nham_get: not implemented\n";
}
-=head2 nspam_nham_change
+=item nspam_nham_change
public instance (Boolean) nspam_nham_change (Integer $num_spam,
Integer $num_ham)
@@ -684,7 +687,7 @@
die "bayes: nspam_nham_change: not implemented\n";
}
-=head2 tok_touch
+=item tok_touch
public instance (Boolean) tok_touch (String $token,
Time $atime)
@@ -699,7 +702,7 @@
die "bayes: tok_touch: not implemanted\n";
}
-=head2 tok_touch_all
+=item tok_touch_all
public instance (Boolean) tok_touch_all (\@ $tokens,
Time $atime)
@@ -715,7 +718,7 @@
die "bayes: tok_touch_all: not implemanted\n";
}
-=head2 cleanup
+=item cleanup
public instance (Boolean) cleanup ()
@@ -730,7 +733,7 @@
die "bayes: cleanup: not implemented\n";
}
-=head2 get_magic_re
+=item get_magic_re
public instance get_magic_re (String)
@@ -744,7 +747,7 @@
die "bayes: get_magic_re: not implemented\n";
}
-=head2 sync
+=item sync
public instance (Boolean) sync (\% $opts)
@@ -758,7 +761,7 @@
die "bayes: sync: not implemented\n";
}
-=head2 perform_upgrade
+=item perform_upgrade
public instance (Boolean) perform_upgrade (\% $opts)
@@ -776,7 +779,7 @@
die "bayes: perform_upgrade: not implemented\n";
}
-=head2 clear_database
+=item clear_database
public instance (Boolean) clear_database ()
@@ -793,7 +796,7 @@
die "bayes: clear_database: not implemented\n";
}
-=head2 backup_database
+=item backup_database
public instance (Boolean) backup_database ()
@@ -807,7 +810,7 @@
die "bayes: backup_database: not implemented\n";
}
-=head2 restore_database
+=item restore_database
public instance (Boolean) restore_database (String $filename, Boolean $showdots)
@@ -824,7 +827,7 @@
die "bayes: restore_database: not implemented\n";
}
-=head2 db_readable
+=item db_readable
public instance (Boolean) db_readable ()
@@ -839,7 +842,7 @@
die "bayes: db_readable: not implemented\n";
}
-=head2 db_writable
+=item db_writable
public instance (Boolean) db_writable ()
@@ -858,3 +861,7 @@
sub sa_die { Mail::SpamAssassin::sa_die(@_); }
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm Tue Jul 12 17:59:26 2005
@@ -845,7 +845,11 @@
type => $CONF_TYPE_STRING
});
+=back
+
=head2 NETWORK TEST OPTIONS
+
+=over 4
=item trusted_networks ip.add.re.ss[/mask] ... (default: none)
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/DnsResolver.pm Tue Jul 12 17:59:26 2005
@@ -18,8 +18,6 @@
Mail::SpamAssassin::DnsResolver - DNS resolution engine
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
This is a DNS resolution engine for SpamAssassin, implemented in order to
@@ -429,3 +427,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Logger.pm Tue Jul 12 17:59:26 2005
@@ -71,7 +71,7 @@
=head1 METHODS
-=over
+=over 4
=item add_facilities(facilities)
@@ -305,3 +305,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Message.pm Tue Jul 12 17:59:26 2005
@@ -18,12 +18,20 @@
Mail::SpamAssassin::Message - decode, render, and hold an RFC-2822 message
-=head1 SYNOPSIS
-
=head1 DESCRIPTION
-This module will encapsulate an email message and allow access to
-the various MIME message parts and message metadata.
+This module encapsulates an email message and allows access to the various MIME
+message parts and message metadata.
+
+The message structure, after initiating a parse() cycle, looks like this:
+
+ Message object, also top-level node in Message::Node tree
+ |
+ +---> Message::Node for other parts in MIME structure
+ | |---> [ more Message::Node parts ... ]
+ | [ others ... ]
+ |
+ +---> Message::Metadata object to hold metadata
=head1 PUBLIC METHODS
@@ -31,16 +39,6 @@
=cut
-# the message structure, after initiating a parse() cycle, is now:
-#
-# Message object, also top-level node in Message::Node tree
-# |
-# +---> Message::Node for other parts in MIME structure
-# | |---> [ more Message::Node parts ... ]
-# | [ others ... ]
-# |
-# +---> Message::Metadata object to hold metadata
-
package Mail::SpamAssassin::Message;
use strict;
@@ -1009,3 +1007,7 @@
# ---------------------------------------------------------------------------
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/PersistentAddrList.pm Tue Jul 12 17:59:26 2005
@@ -158,3 +158,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AWL.pm Tue Jul 12 17:59:26 2005
@@ -162,6 +162,8 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING
});
+=back
+
=head1 ADMINISTRATOR SETTINGS
These settings differ from the ones above, in that they are considered 'more
@@ -169,6 +171,8 @@
No matter what C<allow_user_rules> is set to, these can never be set from a
user's C<user_prefs> file.
+=over 4
+
=item auto_whitelist_factory module (default: Mail::SpamAssassin::DBBasedAddrList)
Select alternative whitelist factory module.
@@ -297,8 +301,6 @@
The table user auto-whitelists are stored in, for the above DSN.
-=back
-
=cut
push (@cmds, {
@@ -512,5 +514,8 @@
return $status;
}
-
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/AutoLearnThreshold.pm Tue Jul 12 17:59:26 2005
@@ -80,6 +80,8 @@
The following configuration settings are used to control auto-learning:
+=over 4
+
=item bayes_auto_learn_threshold_nonspam n.nn (default: 0.1)
The score threshold below which a mail has to score, to be fed into
@@ -191,3 +193,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DCC.pm Tue Jul 12 17:59:26 2005
@@ -38,8 +38,6 @@
See http://www.rhyolite.com/anti-spam/dcc/ for more information about
DCC.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::DCC;
@@ -84,6 +82,8 @@
=head1 USER OPTIONS
+=over 4
+
=item use_dcc (0|1) (default: 1)
Whether to use DCC, if it is available.
@@ -142,8 +142,12 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
+=back
+
=head1 ADMINISTRATOR OPTIONS
+=over 4
+
=item dcc_home STRING
This option tells SpamAssassin specifically where to find the dcc homedir.
@@ -634,3 +638,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Hashcash.pm Tue Jul 12 17:59:26 2005
@@ -30,6 +30,8 @@
=cut
+=head1 USER SETTINGS
+
=over 4
=item use_hashcash { 1 | 0 } (default: 1)
@@ -329,3 +331,7 @@
############################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Pyzor.pm Tue Jul 12 17:59:26 2005
@@ -29,8 +29,6 @@
See http://pyzor.sourceforge.net/ for more information about Pyzor.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::Pyzor;
@@ -75,6 +73,8 @@
=head1 USER OPTIONS
+=over 4
+
=item use_pyzor (0|1) (default: 1)
Whether to use Pyzor, if it is available.
@@ -117,8 +117,12 @@
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
+=back
+
=head1 ADMINISTRATOR OPTIONS
+=over 4
+
=item pyzor_options options
Specify additional options to the pyzor(1) command. Please note that only
@@ -381,3 +385,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Razor2.pm Tue Jul 12 17:59:26 2005
@@ -36,6 +36,8 @@
See http://razor.sourceforge.net/ for more information about Razor.
+=head1 USER SETTINGS
+
=over 4
=cut
@@ -460,3 +462,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ReplaceTags.pm Tue Jul 12 17:59:26 2005
@@ -263,3 +263,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SPF.pm Tue Jul 12 17:59:26 2005
@@ -75,6 +75,10 @@
my($self, $conf) = @_;
my @cmds = ();
+=head1 USER SETTINGS
+
+=over 4
+
=item whitelist_from_spf add@ress.com
Use this to supplement the whitelist_from addresses with a check against the
@@ -451,3 +455,7 @@
###########################################################################
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/SpamCop.pm Tue Jul 12 17:59:26 2005
@@ -36,8 +36,6 @@
See http://www.spamcop.net/ for more information about SpamCop.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::SpamCop;
@@ -84,6 +82,8 @@
=head1 USER OPTIONS
+=over 4
+
=item spamcop_from_address add@ress.com (default: none)
This address is used during manual reports to SpamCop as the From:
@@ -138,8 +138,6 @@
},
});
-=over 4
-
=item spamcop_max_report_size (default: 50)
Messages larger than this size (in kilobytes) will be truncated in
@@ -293,3 +291,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TextCat.pm Tue Jul 12 17:59:26 2005
@@ -37,8 +37,6 @@
Note: the language cannot always be recognized with sufficient
confidence. In that case, C<UNWANTED_LANGUAGE_BODY> will not trigger.
-=over 4
-
=cut
package Mail::SpamAssassin::Plugin::TextCat;
@@ -105,6 +103,8 @@
=head1 USER OPTIONS
+=over 4
+
=item ok_languages xx [ yy zz ... ] (default: all)
This option is used to specify which languages are considered okay for
@@ -297,8 +297,6 @@
Gaelic, Scottish Gaelic, Icelandic, Latin, Lithuanian, Latvian,
Rhaeto-Romance, Sanskrit, Scots, Slovenian, and Yiddish.
-=over 4
-
=cut
push (@cmds, {
@@ -531,3 +529,7 @@
}
1;
+
+=back
+
+=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/WhiteListSubject.pm Tue Jul 12 17:59:26 2005
@@ -16,7 +16,7 @@
=head1 NAME
-Mail::SpamAssassin::Plugin::WhiteListSubject
+Mail::SpamAssassin::Plugin::WhiteListSubject - whitelist by Subject header
=head1 SYNOPSIS
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm?rev=216068&r1=216067&r2=216068&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Util.pm Tue Jul 12 17:59:26 2005
@@ -1,11 +1,3 @@
-# A general class for utility functions. Please use this for
-# functions that stand alone, without requiring a $self object,
-# Portability functions especially.
-#
-# NOTE: The functions in this module are all considered private. Their API
-# may change at any point, and it's expected that they'll only be used by
-# other Mail::SpamAssassin modules.
-
# <@LICENSE>
# Copyright 2004 Apache Software Foundation
#
@@ -22,6 +14,25 @@
# limitations under the License.
# </@LICENSE>
+=head1 NAME
+
+Mail::SpamAssassin::Util - utility functions
+
+=head1 DESCRIPTION
+
+A general class for utility functions. Please use this for functions that
+stand alone, without requiring a $self object, Portability functions
+especially.
+
+NOTE: The functions in this module are to be considered private. Their API may
+change at any point, and it's expected that they'll only be used by other
+Mail::SpamAssassin modules. (TODO: we should probably revisit this if
+it's useful for plugin development.)
+
+=over 4
+
+=cut
+
package Mail::SpamAssassin::Util;
use strict;
@@ -1303,3 +1314,7 @@
###########################################################################
1;
+
+=back
+
+=cut