Anonymous avatar Anonymous committed 1839cf4

More POD coverage.

Comments (0)

Files changed (3)

modules/Mail-LMLM/lib/Mail/LMLM/Render/HTML.pm

     return 0;
 }
 
-sub htmlize_onechar
+sub _htmlize_onechar
 {
     my $c = shift;
 
     }
 }
 
-sub htmlize
+sub _htmlize
 {
     my $text = shift;
 
-    $text =~ s/(<|>|\&|\n)/&htmlize_onechar($1)/ge;
+    $text =~ s/(<|>|\&|\n)/_htmlize_onechar($1)/ge;
 
     return $text;
 }
         $style = {};
     }
 
-    my $out = htmlize($text);
+    my $out = _htmlize($text);
 
     if ($style->{'bold'})
     {
 
 1;
 
+=head1 NAME
+
+Mail::LMLM::Render::HTML - backend for rendering HTML.
+
+=head1 SYNOPSIS
+
+    use Mail::LMLM::Render::HTML;
+
+    open O, ">out.html";
+    my $r = Mail::LMLM::Render::HTML->new(\*O);
+
+    $r->start_document("My Document", "Head Title");
+    
+    $r->start_section("Google", { 'title_url' => "http://www.google.com/", });
+    
+    $r->para("Google is a very nice search engine.");
+    $r->end_section();
+    $r->end_document();
+    close(O);
+
+=head1 DESCRIPTION
+
+This is a derived class of L<Mail::LMLM::Render> that renders HTML.
+
+=head1 METHODS
+
+=head2 start_document($head_title, $body_title)
+
+=head2 end_document()
+
+=head2 start_section($title [, { 'title_url' => $url } ])
+
+=head2 end_section()
+
+=head2 start_para()
+
+=head2 end_para()
+
+=head2 text($text [, $style])
+
+=head2 newline()
+
+=head2 start_link($url)
+
+=head2 end_link()
+
+=head2 indent_inc()
+
+=head2 indent_dec()
+
+=head2 horizontal_line()
+
+=head2 email_address($account,$host)
+
+=head2 url($url [, $inside])
+
+=head2 para($text [, $style])
+
+See the documentation at L<Mail::LMLM::Render>.
+
+=head2 initialize()
+
+Construction method. For internal use.
+
+=head1 AUTHOR
+
+Shlomi Fish L<http://www.shlomifish.org/>.
+
+

modules/Mail-LMLM/lib/Mail/LMLM/Types/Base.pm

 }
 
 1;
+
+__END__
+=head1 NAME
+
+Mail::LMLM::Types::Base - the base class for the mailing list types.
+
+=head1 SYNOPSIS
+
+Extend the class.
+
+=head1 METHODS
+
+=head2 Mail::LMLM::Types::MyMailingListType->new(%args)
+
+%args keys can be:
+
+=over 4
+
+=item * id
+
+The id of the mailing list - used for URLs, etc.
+
+=item * group_base
+
+The base username of the mailing list.
+
+=item * desc (or description)
+
+The description of the mailing list.
+
+=item * hostname
+
+The hostname where the mailing list is hosted.
+
+=item * homepage
+
+The mailing list's homepage
+
+=item * online_archive
+
+The online archive of the mailing list (can be a coderef).
+
+=item * guidelines
+
+Guidelines for posting on the list.
+
+=item * notes
+
+Notes for the mailing list.
+
+=back
+
+=head2 get_id()
+
+An accessor for the ID.
+
+=head2 get_description()
+
+An accessor for the description.
+
+=head2 get_homepage
+
+An accessor for the homepage. (may be overrided by derived classes).
+
+=head2 get_group_base
+
+An accessor for the group base.
+
+=head2 get_hostname
+
+An accessor for the hostname.
+
+=head2 get_online_archive
+
+An accessor for the online archive.
+
+=head2 get_guidelines
+
+An accessor for the guidelines.
+
+=head2 render_subscribe
+
+Render the subscribe part.
+
+=head2 render_unsubscribe
+
+Render the unsubscribe part.
+
+=head2 render_post
+
+Render the post part.
+
+=head2 render_owner
+
+Render the owner part.
+
+=head2 render_none
+
+Render a paragraph saying "None".
+
+=head2 render_homepage
+
+Render the homepage part.
+
+=head2 render_online_archive
+
+Render the online archive part.
+
+=head2 $self->render_field($htmler, $desc)
+
+Renders the $desc using the rendered.
+
+=head2 render_description
+
+Render the description part.
+
+=head2 render_guidelines
+
+Render the guidelines part.
+
+=head2 $type->render_something_with_email_addr($htmler, $begin_msg, $address_method)
+
+Render something with the email address.
+
+=head1 INTERNAL METHODS
+
+=head2 initialize()
+
+This is a helper for new(). For internal use.
+
+=head2 parse_args()
+
+This is a helper for initialize(). For internal use.
+
+=head1 SEE ALSO
+
+L<Mail::LMLM>
+
+=head1 AUTHOR
+
+Shlomi Fish, L<http://www.shlomifish.org/>
+

modules/Mail-LMLM/lib/Mail/LMLM/Types/Listserv.pm

 
 @ISA=qw(Mail::LMLM::Types::Base);
 
-sub get_subscribe_address
-{
-    my $self = shift;
-    
-    return $self->group_form("subscribe");
-}
-
-sub get_unsubscribe_address
-{
-    my $self = shift;
-
-    return $self->group_form("unsubscribe");
-}
-
-sub get_post_address
+sub _get_post_address
 {
     my $self = shift;
 
     return ($self->get_group_base(), $self->get_hostname());
 }
 
-sub get_owner_address
+sub _get_owner_address
 {
     my $self = shift;
 
     return $self->render_something_with_email_addr(
         $htmler,
         "Send your messages to the following address: ",
-        \&get_post_address
+        \&_get_post_address
         );
 }
 
     return $self->render_something_with_email_addr(
         $htmler,
         "Send messages to the mailing-list owner to the following address: ",
-        \&get_owner_address
+        \&_get_owner_address
         );
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+Mail::LMLM::Types::Listserv - mailing list type for listserv.
+
+=head1 METHODS
+
+=head2 render_mail_management
+
+Internal method.
+
+=head2 render_subscribe
+
+Over-rides the equivalent from L<Mail::LMLM::Types::Base>.
+
+=head2 render_unsubscribe
+
+Over-rides the equivalent from L<Mail::LMLM::Types::Base>.
+
+=head2 render_post
+
+Over-rides the equivalent from L<Mail::LMLM::Types::Base>.
+ 
+=head2 render_owner
+
+Over-rides the equivalent from L<Mail::LMLM::Types::Base>.
+
+=head1 SEE ALSO
+
+L<Mail::LMLM::Types::Base>
+
+=head1 AUTHOR
+
+Shlomi Fish, L<http://www.shlomifish.org/>.
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.