diff options
Diffstat (limited to 'lib/Sietima/Types.pm')
-rw-r--r-- | lib/Sietima/Types.pm | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/lib/Sietima/Types.pm b/lib/Sietima/Types.pm index e7a576d..9f052e3 100644 --- a/lib/Sietima/Types.pm +++ b/lib/Sietima/Types.pm @@ -20,9 +20,7 @@ use Type::Library This module is a L<< C<Type::Library> >>. It declares a few type constraints nad coercions. -=head1 TYPES - -=head2 C<SietimaObj> +=type C<SietimaObj> An instance of L<< C<Sietima> >>. @@ -30,7 +28,7 @@ An instance of L<< C<Sietima> >>. class_type SietimaObj, { class => 'Sietima' }; -=head2 C<EmailMIME> +=type C<EmailMIME> An instance of L<< C<Email::MIME> >>. @@ -38,7 +36,7 @@ An instance of L<< C<Email::MIME> >>. class_type EmailMIME, { class => 'Email::MIME' }; -=head2 C<Transport> +=type C<Transport> An object that consumes the role L<< C<Email::Sender::Transport> >>. @@ -46,7 +44,7 @@ An object that consumes the role L<< C<Email::Sender::Transport> >>. role_type Transport, { role => 'Email::Sender::Transport' }; -=head2 C<MailStore> +=type C<MailStore> An object that consumes the role L<< C<Sietima::MailStore> >>. @@ -79,7 +77,7 @@ declare_coercion MailStoreFromHashRef, q{ require Module::Runtime; } . q{ Module::Runtime::use_module(delete $_->{class})->new($_); }; -=head2 C<Address> +=type C<Address> An instance of L<< C<Email::Address> >>. @@ -104,7 +102,7 @@ declare_coercion AddressFromStr, to_type Address, from Str, q{ (Email::Address->parse($_))[0] }; -=head2 C<TagName> +=type C<TagName> A string composed exclusively of "word" (C</\w/>) characters. Used by L<mail stores|Sietima::MailStore> to tag messages. @@ -118,7 +116,7 @@ declare TagName, as Str, .qq{ && ($varname =~/\\A\\w+\\z/) }; }; -=head2 C<Message> +=type C<Message> An instance of L<< C<Sietima::Message> >>. @@ -126,7 +124,7 @@ An instance of L<< C<Sietima::Message> >>. class_type Message, { class => 'Sietima::Message' }; -=head2 C<Subscriber> +=type C<Subscriber> An instance of L<< C<Sietima::Subscriber> >>. |