Commit 5ebbe536 authored by sikeda's avatar sikeda
Browse files

[dev: Adding documentations.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@12653 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent f96e8859
......@@ -252,3 +252,27 @@ our %comms = (
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::CommandDef - Definition of mail commands
=head1 SYNOPSIS
TBD
=head1 DESCRIPTION
TBD
=head1 SEE ALSO
L<Sympa::Request::Message>.
=head1 HISTORY
L<Sympa::CommandDef> appeared on Sympa 6.2.13.
=cut
......@@ -228,3 +228,47 @@ sub _get_auth_method {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::AuthorizeRequest -
Workflow to authorize requests in command messages
=head1 DESCRIPTION
L<Sympa::Spindle::AuthorizeRequest> authorizes requests and stores them
into request spool or dispatch them.
TBD
=head2 Public methods
See also L<Sympa::Spindle/"Public methods">.
=over
=item new ( key =E<gt> value, ... )
In most cases, L<Sympa::Spindle::ProcessMessage>
splices meessages to this class. This method is not used in ordinal case.
=item spin ( )
Not implemented.
=back
=head1 SEE ALSO
L<Sympa::Request>, L<Sympa::Scenario>, L<Sympa::Spindle::DispatchRequest>,
L<Sympa::Spindle::ProcessMessage>, L<Sympa::Spindle::ProcessRequest>,
L<Sympa::Spindle::ToAuth>, L<Sympa::Spindle::ToRequest>.
=head1 HISTORY
L<Sympa::Spindle::AuthorizeRequest> appeared on Sympa 6.2.13.
=cut
......@@ -2189,3 +2189,46 @@ sub which {
#sub get_auth_method;
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::DispatchRequest -
Workflow to dispatch requests
=head1 DESCRIPTION
L<Sympa::Spindle::DispatchRequest> dispatches requests, in most cases
included in command messages.
Requests are dispatched to routines to perform abstruct processing.
=head2 Public methods
See also L<Sympa::Spindle/"Public methods">.
=over
=item new ( key =E<gt> value, ... )
In most cases, L<Sympa::Spindle::ProcessMessage>
splices requests to this class. This method is not used in ordinal case.
=item spin ( )
Not implemented.
=back
=head1 SEE ALSO
L<Sympa::Spindle>, L<Sympa::Spindle::ProcessMessage>,
L<Sympa::Spindle::ProcessRequest>.
=head1 HISTORY
L<Sympa::Spindle::DispatchRequest> appeared on Sympa 6.2.13.
=cut
......@@ -106,3 +106,27 @@ sub _twist {
}
1;
__END__
=encoding utf-8
=head1 NAME
Sympa::Spindle::ToRequest -
Process to store requests into request spool to wait for moderation
=head1 DESCRIPTION
TBD.
=head1 SEE ALSO
L<Sympa::Request>,
L<Sympa::Spindle>, L<Sympa::Spindle::AuthorizeRequest>,
L<Sympa::Spool::Request>.
=head1 HISTORY
L<Sympa::Spindle::ToRequest> 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