Commit f8495522 authored by sikeda's avatar sikeda
Browse files

[dev] Adding documentation.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@12603 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 3c38b479
......@@ -269,6 +269,8 @@ Default is false.
=head1 HISTORY
Feature to compile notification to listmaster in group appeared on Sympa 6.2.
L<Sympa::Alarm> appeared on Sympa 6.2.
=cut
......@@ -280,11 +280,55 @@ __END__
=head1 NAME
Sympa::ListOpt - Names of options
Sympa::ListOpt - Definition of list configuration parameter values
=head1 DESCRIPTION
TBD.
L<Sympa::ListOpt> gives information about options used for values of list
configuration.
=head2 Function
=over
=item get_title ( $value, [ $type, [ $withval ] ] )
I<Function>.
Gets i18n-ed title of option.
Language context must be set in advance (See L<Sympa::Language>).
Parameters:
=over
=item $value
Value of option.
=item $type
Type of option.
C<'reception'> (reception mode of list member),
C<'visibility'> (visibility mode of list memeber),
C<'status'> (status of list)
or other (list config option, default).
=item $withval
Adds value of option to returned title.
=back
Returns:
I18n-ed title of option value.
=back
=head1 SEE ALSO
L<Sympa::Language>,
L<Sympa::ListDef>.
=head1 HISTORY
......
......@@ -384,6 +384,8 @@ Not implemented.
L<Sympa::Message>, L<Sympa::Scenario>, L<Sympa::Spindle::DistributeMessage>,
L<Sympa::Spindle::DoMessage>, L<Sympa::Spindle::ProcessHeld>,
L<Sympa::Spindle::ToEditor>, L<Sympa::Spindle::ToHeld>,
L<Sympa::Spindle::ToModeration>,
L<Sympa::Topic>.
=head1 HISTORY
......
......@@ -102,7 +102,8 @@ Not implemented.
=head1 SEE ALSO
L<Sympa::Spindle>, L<Sympa::Spindle::DoMessage>.
L<Sympa::Spindle>, L<Sympa::Spindle::DoMessage>,
L<Sympa::Spindle::ProcessModeration>.
=head1 HISTORY
......
......@@ -71,3 +71,87 @@ sub _twist {
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ProcessTemplate - Workflow of template sending
=head1 SYNOPSIS
use Sympa::Spindle::ProcessTemplate;
my $spindle = Sympa::Spindle::ProcessTemplate->new( options... );
$spindle->spin;
=head1 DESCRIPTION
L<Sympa::Spindle::ProcessTemplate> defines workflow to send messages
generated from template.
When spin() method is invoked, it takes an message generated from template,
sends the message using another outgoing spindle and returns.
=head2 Public methods
See also L<Sympa::Spindle/"Public methods">.
=over
=item new ( I<template options>, [ splicing_to =E<gt> [spindles] ],
[ add_list_statistics =E<gt> 1 ] )
=item spin ( )
new() may take following options.
=over
=item I<template options>
See L<Sympa::Message::Template/"new">.
=item splicing_to =E<gt> [spindles]
A reference to array containing L<Sympa::Spindle> subclass(es) by which
the message will be sent.
By default C<['Sympa::Spindle::ToOutgoing']> is used.
=item add_list_statistics =E<gt> 1
TBD.
=back
=back
=head2 Properties
See also L<Sympa::Spindle/"Properties">.
=over
=item {distaff}
Instance of L<Sympa::Message::Template> class.
=item {finish}
C<'success'> is set if processing succeeded.
C<'failure'> is set if processing failed.
=back
=head1 SEE ALSO
L<Sympa::Message::Template>,
L<Sympa::Spindle>,
L<Sympa::Spindle::ToAlarm>, L<Sympa::Spindle::ToMailer>,
L<Sympa::Spindle::ToOutgoing>.
=head1 HISTORY
L<Sympa::Spindle::ProcessTemplate> appeared on Sympa 6.2.13.
=cut
......@@ -41,3 +41,26 @@ sub _twist {
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToAlarm -
Process to store messages into spool on memory for listmaster notification
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>, L<Sympa::Spindle::ProcessTemplate>,
L<Sympa::Alarm>.
=head1 HISTORY
L<Sympa::Spindle::ToAlarm> appeared on Sympa 6.2.13.
=cut
......@@ -174,3 +174,25 @@ sub _send_confirm_to_editor {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToEditor - Process to forward messages to list editors
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>, L<Sympa::Spindle::AuthorizeMessage>.
=head1 HISTORY
L<Sympa::Spindle::ToEditor> appeared on Sympa 6.2.13.
=cut
......@@ -138,3 +138,27 @@ sub _send_confirm_to_sender {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToHeld -
Process to store messages into held spool to wait for confirmation
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>, L<Sympa::Spindle::AuthorizeMessage>,
L<Sympa::Spool::Held>.
=head1 HISTORY
L<Sympa::Spindle::ToHeld> appeared on Sympa 6.2.13.
=cut
......@@ -43,3 +43,25 @@ sub _twist {
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToMailer - Process to store messages into sendmail component
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>,
L<Sympa::Mailer>.
=head1 HISTORY
L<Sympa::Spindle::ToMailer> appeared on Sympa 6.2.13.
=cut
......@@ -220,3 +220,27 @@ sub _send_confirm_to_editor {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToModeration -
Process to store messages into held spool to wait for moderation
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>, L<Sympa::Spindle::AuthorizeMessage>,
L<Sympa::Spool::Moderation>.
=head1 HISTORY
L<Sympa::Spindle::ToModeration> appeared on Sympa 6.2.13.
=cut
......@@ -57,3 +57,25 @@ sub _twist {
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToOutgoing - Process to store messages into outgoing spool
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Message>,
L<Sympa::Spindle>,
L<Sympa::Bulk>.
=head1 HISTORY
L<Sympa::Spindle::ToOutgoing> appeared on Sympa 6.2.13.
=cut
......@@ -65,7 +65,22 @@ Process to transform digest messages - final stage
=head1 DESCRIPTION
TBD.
L<Sympa::Spindle::TransformDigestFinal> decorates messages bound for list
members with C<digest>, C<digestplain> or C<summary> reception mode.
This class represents the series of following processes:
=over
=item *
Adding RFC 2919 C<List-Id:> header field.
=item *
Adding RFC 2369 mailing list header fields.
=back
=head1 SEE ALSO
......
......@@ -180,3 +180,26 @@ sub load {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Ticket - One-time ticket for authorization
=head1 SYNOPSIS
TBD.
=head1 DESCRIPTION
TBD.
=head1 HISTORY
Feature to handle one-time ticket was introduced on Sympa 6.0b.2.
L<Sympa::Ticket> module appeared on Sympa 6.2.13.
=cut
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment