Changeset 497 for wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/Listing.pm

Timestamp:

02/01/09 00:06:59 (3 years ago)

Author:

dom

Message:

fix up pod and add pod testing (fixes #45)

Files:

• wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/Listing.pm (modified) (13 diffs)

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/Listing.pm

@@ -4 +4 @@
 use Carp qw( croak );
 
-=item B<fetch_recently_changed_nodes>
+=head1 NAME
+
+Wiki::Toolkit::Feed::Listing - parent class for Feeds from Wiki::Toolkit.
+
+=head1 DESCRIPTION
+
+Handles common data fetching tasks, so that child classes need only
+worry about formatting the feeds.
+
+Also enforces some common methods that must be implemented.
+
+=head1 METHODS
+
+=head2 C<fetch_recently_changed_nodes>
 
 Based on the supplied criteria, fetch a list of the recently changed nodes
@@ -40 +53 @@
 }
 
-=item B<fetch_newest_for_recently_changed>
+=head2 C<fetch_newest_for_recently_changed>
 
 Based on the supplied criteria (but not using all of those used by
@@ -56 +69 @@
 
 
-=item B<fetch_node_all_versions>
+=head2 C<fetch_node_all_versions>
 
 For a given node (name or ID), return all the versions there have been,
@@ -92 +105 @@
 
 
-=item B<recent_changes>
+=head2 C<recent_changes>
 
 Build an Atom Feed of the recent changes to the Wiki::Toolkit instance,
@@ -120 +133 @@
 
 
-=item B<node_all_versions>
+=head2 C<node_all_versions>
 
 Build an Atom Feed of all the different versions of a given node.
@@ -144 +157 @@
 } 
 
-=item B<format_geo>
+=head2 C<format_geo>
 
 Using the geo and space xml namespaces, format the supplied node metadata
@@ -187 +200 @@
 }
 
-#item B<handle_supply_one_of>
 # Utility method, to help with argument passing where one of a list of 
 #  arguments must be supplied
-#
-#=cut
 
 sub handle_supply_one_of {
@@ -214 +224 @@
 
 
-# The following are methods that any feed renderer must provide
-
-=item B<feed_timestamp>
+=pod
+
+The following are methods that any feed renderer must provide:
+
+=head2 C<feed_timestamp>
 
 All implementing feed renderers must implement a method to produce a
@@ -225 +237 @@
 sub feed_timestamp          { die("Not implemented by feed renderer!"); }
 
-=item B<generate_node_list_feed>
+=head2 C<generate_node_list_feed>
 
 All implementing feed renderers must implement a method to produce a
@@ -234 +246 @@
 sub generate_node_list_feed { die("Not implemented by feed renderer!"); }
 
-=item B<generate_node_name_distance_feed>
+=head2 C<generate_node_name_distance_feed>
 
 All implementing feed renderers must implement a method to produce a
@@ -244 +256 @@
 sub generate_node_name_distance_feed { die("Not implemented by feed renderer!"); }
 
-=item B<parse_feed_timestamp>
+=head2 C<parse_feed_timestamp>
 
 Take a feed_timestamp and return a Time::Piece object. 
@@ -256 +268 @@
 __END__
 
-=head1 NAME
-
-Wiki::Toolkit::Feed::Listing - parent class for Feeds from Wiki::Toolkit.
-
-=head1 DESCRIPTION
-
-Handles common data fetching tasks, so that child classes need only
-worry about formatting the feeds.
-
-Also enforces some common methods that must be implemented.
-
 =head1 MAINTAINER
 
@@ -273 +274 @@
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 the Wiki::Toolkit team.
+Copyright 2006-2009 the Wiki::Toolkit team.
 
 This module is free software; you can redistribute it and/or modify it