[Jifty-commit] r3611 - in jifty/trunk: . lib/Jifty lib/Jifty/Action/Record lib/Jifty/Event lib/Jifty/Mason lib/Jifty/Module lib/Jifty/Script lib/Jifty/Subs lib/Jifty/Upgrade lib/Jifty/View/Declare lib/Jifty/View/Static lib/Jifty/Web lib/Jifty/Web/Form/Field

jifty-commit at lists.jifty.org jifty-commit at lists.jifty.org
Fri Jul 6 12:36:41 EDT 2007


Author: sterling
Date: Fri Jul  6 12:36:35 2007
New Revision: 3611

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Action/Record/Search.pm
   jifty/trunk/lib/Jifty/CurrentUser.pm
   jifty/trunk/lib/Jifty/Event.pm
   jifty/trunk/lib/Jifty/Event/Model.pm
   jifty/trunk/lib/Jifty/Mason/Halo.pm
   jifty/trunk/lib/Jifty/Model/SessionCollection.pm
   jifty/trunk/lib/Jifty/Module/Pluggable.pm
   jifty/trunk/lib/Jifty/Notification.pm
   jifty/trunk/lib/Jifty/Object.pm
   jifty/trunk/lib/Jifty/RightsFrom.pm
   jifty/trunk/lib/Jifty/Script.pm
   jifty/trunk/lib/Jifty/Script/Deps.pm
   jifty/trunk/lib/Jifty/Server.pm
   jifty/trunk/lib/Jifty/Subs.pm
   jifty/trunk/lib/Jifty/Subs/Render.pm
   jifty/trunk/lib/Jifty/Upgrade.pm
   jifty/trunk/lib/Jifty/Upgrade/Internal.pm
   jifty/trunk/lib/Jifty/View/Declare/CoreTemplates.pm
   jifty/trunk/lib/Jifty/View/Declare/Handler.pm
   jifty/trunk/lib/Jifty/View/Declare/Helpers.pm
   jifty/trunk/lib/Jifty/View/Static/Handler.pm
   jifty/trunk/lib/Jifty/Web/Form.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Button.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Checkbox.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Combobox.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Date.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Hidden.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/InlineButton.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Password.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Radio.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/ResetButton.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Select.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Text.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Textarea.pm
   jifty/trunk/lib/Jifty/Web/Form/Field/Unrendered.pm
   jifty/trunk/lib/Jifty/Web/Menu.pm

Log:
 r7940 at dynpc145:  andrew | 2007-07-06 11:34:54 -0500
 Added NAME sections and short descriptions for the CPAN module summary.


Modified: jifty/trunk/lib/Jifty/Action/Record/Search.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Action/Record/Search.pm	(original)
+++ jifty/trunk/lib/Jifty/Action/Record/Search.pm	Fri Jul  6 12:36:35 2007
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-Jifty::Action::Record::Search
+Jifty::Action::Record::Search - Automagic search action
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/CurrentUser.pm
==============================================================================
--- jifty/trunk/lib/Jifty/CurrentUser.pm	(original)
+++ jifty/trunk/lib/Jifty/CurrentUser.pm	Fri Jul  6 12:36:35 2007
@@ -11,7 +11,7 @@
 
 =head1 NAME
 
-Jifty::CurrentUser
+Jifty::CurrentUser - Base class and basic implementation of current user object
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Event.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Event.pm	(original)
+++ jifty/trunk/lib/Jifty/Event.pm	Fri Jul  6 12:36:35 2007
@@ -9,7 +9,7 @@
 
 =head1 NAME
 
-Jifty::Event
+Jifty::Event - Event objects for publish/subscribe communication
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Event/Model.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Event/Model.pm	(original)
+++ jifty/trunk/lib/Jifty/Event/Model.pm	Fri Jul  6 12:36:35 2007
@@ -9,7 +9,7 @@
 
 =head1 NAME
 
-Jifty::Event::Model
+Jifty::Event::Model - Events representing changes to records
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Mason/Halo.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Mason/Halo.pm	(original)
+++ jifty/trunk/lib/Jifty/Mason/Halo.pm	Fri Jul  6 12:36:35 2007
@@ -7,7 +7,7 @@
 
 =head1 NAME
 
-Jifty::Mason::Halo
+Jifty::Mason::Halo - Class for drawing "halos" around page components
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Model/SessionCollection.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Model/SessionCollection.pm	(original)
+++ jifty/trunk/lib/Jifty/Model/SessionCollection.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Collection/;
 
+=head1 NAME
+
+Jifty::Model::SessionCollection - Specialized handling of the session collection
+
+=head2 METHODS
+
 =head2 record_class
 
 This deals with collections of L<Jifty::Model::Session>s.

Modified: jifty/trunk/lib/Jifty/Module/Pluggable.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Module/Pluggable.pm	(original)
+++ jifty/trunk/lib/Jifty/Module/Pluggable.pm	Fri Jul  6 12:36:35 2007
@@ -5,7 +5,7 @@
 
 =head1 NAME
 
-Jifty::Module::Pluggable
+Jifty::Module::Pluggable - Jifty-specific helper for Module::Pluggable
 
 
 =head1 DESCRIPTION

Modified: jifty/trunk/lib/Jifty/Notification.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Notification.pm	(original)
+++ jifty/trunk/lib/Jifty/Notification.pm	Fri Jul  6 12:36:35 2007
@@ -10,6 +10,10 @@
 __PACKAGE__->mk_accessors(
     qw/body preface footer subject from _recipients _to_list to/);
 
+=head1 NAME
+
+Jifty::Notification - Send emails from Jifty
+
 =head1 USAGE
 
 It is recommended that you subclass L<Jifty::Notification> and

Modified: jifty/trunk/lib/Jifty/Object.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Object.pm	(original)
+++ jifty/trunk/lib/Jifty/Object.pm	Fri Jul  6 12:36:35 2007
@@ -5,7 +5,11 @@
 
 use Log::Log4perl ();
 
-=head1 Jifty::Object
+=head1 NAME
+
+Jifty::Object - Base class for most of Jifty's objects
+
+=head1 DESCRIPTION
 
 C<Jifty::Object> is the superclass of most of Jifty's objects.  It is
 used to provide convenient accessors to important global objects like
@@ -16,7 +20,7 @@
 thus, we will not define C<new> or C<_init> in C<Jifty::Object>.  We
 do assume, however, that C<$self> is a blessed hash reference.
 
-=cut
+=head1 METHODS
 
 =head2 current_user [USER]
 

Modified: jifty/trunk/lib/Jifty/RightsFrom.pm
==============================================================================
--- jifty/trunk/lib/Jifty/RightsFrom.pm	(original)
+++ jifty/trunk/lib/Jifty/RightsFrom.pm	Fri Jul  6 12:36:35 2007
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-Jifty::RightsFrom
+Jifty::RightsFrom - Delegate access control to a related object
 
 =head1 SYNOPSIS
 

Modified: jifty/trunk/lib/Jifty/Script.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script.pm	(original)
+++ jifty/trunk/lib/Jifty/Script.pm	Fri Jul  6 12:36:35 2007
@@ -2,6 +2,12 @@
 use App::CLI;
 use base qw/App::CLI App::CLI::Command/;
 
+=head1 NAME
+
+Jifty::Script - Base class for all bin/jifty commands
+
+=head1 METHODS
+
 =head2 prepare
 
 C<prepare> figures out which command to run. If the user wants

Modified: jifty/trunk/lib/Jifty/Script/Deps.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Deps.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Deps.pm	Fri Jul  6 12:36:35 2007
@@ -12,6 +12,12 @@
 use version;
 use Jifty::Config;
 
+=head1 NAME
+
+Jifty::Script::Deps - Looks for module dependencies and attempts to install them from CPAN
+
+=head1 METHODS
+
 =head2 options
 
 Returns a hash of all the options this script takes. (See the usage message for details)

Modified: jifty/trunk/lib/Jifty/Server.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Server.pm	(original)
+++ jifty/trunk/lib/Jifty/Server.pm	Fri Jul  6 12:36:35 2007
@@ -3,6 +3,10 @@
 
 package Jifty::Server;
 
+=head1 NAME
+
+Jifty::Server - Stand-alone server implementation for Jifty
+
 =head1 SYNOPSIS
 
   use Jifty::Server;

Modified: jifty/trunk/lib/Jifty/Subs.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Subs.pm	(original)
+++ jifty/trunk/lib/Jifty/Subs.pm	Fri Jul  6 12:36:35 2007
@@ -8,7 +8,7 @@
 
 =head1 NAME
 
-Jifty::Subs - 
+Jifty::Subs - Configure subscriptions for the current window or session
 
 =head1 SYNOPSIS
 
@@ -27,7 +27,7 @@
 
 
 
-=cut
+=head1 METHODS
 
 =head2 add PARAMHASH
 

Modified: jifty/trunk/lib/Jifty/Subs/Render.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Subs/Render.pm	(original)
+++ jifty/trunk/lib/Jifty/Subs/Render.pm	Fri Jul  6 12:36:35 2007
@@ -4,7 +4,7 @@
 
 =head1 NAME
 
-Jifty::Subs::Render - 
+Jifty::Subs::Render - Helper for subscriptions rendering
 
 =head1 SYNOPSIS
 

Modified: jifty/trunk/lib/Jifty/Upgrade.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Upgrade.pm	(original)
+++ jifty/trunk/lib/Jifty/Upgrade.pm	Fri Jul  6 12:36:35 2007
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-Jifty::Upgrade
+Jifty::Upgrade - Superclass for schema/data upgrades to Jifty applicaitons
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Upgrade/Internal.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Upgrade/Internal.pm	(original)
+++ jifty/trunk/lib/Jifty/Upgrade/Internal.pm	Fri Jul  6 12:36:35 2007
@@ -9,6 +9,12 @@
 # XXX TODO: there's probably a cleaner way to cope than "INITIAL_VERSION", perhaps using ->VERSIONS
 our $INITIAL_VERSION;
 
+=head1 NAME
+
+Jifty::Upgrade::Internal - Upgrades to Jifty-specific schemas and data
+
+=head1 UPGRADES
+
 =head2 Version 0.60427
 
 Version metadata, previously stored in _db_version, get migrated to

Modified: jifty/trunk/lib/Jifty/View/Declare/CoreTemplates.pm
==============================================================================
--- jifty/trunk/lib/Jifty/View/Declare/CoreTemplates.pm	(original)
+++ jifty/trunk/lib/Jifty/View/Declare/CoreTemplates.pm	Fri Jul  6 12:36:35 2007
@@ -9,7 +9,7 @@
 
 =head1 NAME 
 
-Jifty::View::Declare::CoreTemplates
+Jifty::View::Declare::CoreTemplates - Templates Jifty can't function without
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/View/Declare/Handler.pm
==============================================================================
--- jifty/trunk/lib/Jifty/View/Declare/Handler.pm	(original)
+++ jifty/trunk/lib/Jifty/View/Declare/Handler.pm	Fri Jul  6 12:36:35 2007
@@ -10,7 +10,7 @@
 
 =head1 NAME
 
-Jifty::View::Declare::Handler
+Jifty::View::Declare::Handler - The Jifty view handler for Template::Declare
 
 =head1 METHODS
 

Modified: jifty/trunk/lib/Jifty/View/Declare/Helpers.pm
==============================================================================
--- jifty/trunk/lib/Jifty/View/Declare/Helpers.pm	(original)
+++ jifty/trunk/lib/Jifty/View/Declare/Helpers.pm	Fri Jul  6 12:36:35 2007
@@ -9,7 +9,7 @@
 
 =head1 NAME
 
-Jifty::View::Declare::Helpers
+Jifty::View::Declare::Helpers - Additional subroutines for Jifty TD templates
 
 =head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/View/Static/Handler.pm
==============================================================================
--- jifty/trunk/lib/Jifty/View/Static/Handler.pm	(original)
+++ jifty/trunk/lib/Jifty/View/Static/Handler.pm	Fri Jul  6 12:36:35 2007
@@ -14,7 +14,7 @@
 
 =head1 NAME
 
-Jifty::View::Static::Handler
+Jifty::View::Static::Handler - Jifty view handler for static files
 
 head1 DESCRIPTION
 

Modified: jifty/trunk/lib/Jifty/Web/Form.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form.pm	Fri Jul  6 12:36:35 2007
@@ -7,6 +7,12 @@
 
 __PACKAGE__->mk_accessors(qw(actions printed_actions name call is_open disable_autocomplete target submit_to));
 
+=head1 NAME
+
+Jifty::Web::Form - Tools for rendering and dealing with HTML forms
+
+=head1 METHODS
+
 =head2 new ARGS
 
 Creates a new L<Jifty::Web::Form>.  Arguments:

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Button.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Button.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Button.pm	Fri Jul  6 12:36:35 2007
@@ -9,7 +9,7 @@
 
 =head1 NAME
 
-Jifty::Web::Form::Field::Button
+Jifty::Web::Form::Field::Button - Add buttons to your forms
 
 =cut
 

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Checkbox.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Checkbox.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Checkbox.pm	Fri Jul  6 12:36:35 2007
@@ -6,6 +6,12 @@
 use base qw/Jifty::Web::Form::Field/;
 __PACKAGE__->mk_accessors(qw/checked value/);
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Checkbox - Add checkboxes to your forms
+
+=head1 METHODS
+
 =head2 accessors
 
 Provide C<checked> and C<value> accessors, in addition to

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Combobox.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Combobox.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Combobox.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Combobox - Add comboboxes to your forms
+
+=head1 METHODS
+
 =head2 render_widget
 
 Renders the select widget.

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Date.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Date.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Date.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Date - Add date pickers to your forms
+
+=head1 METHODS
+
 =head2 classes
 
 Output date fields with the class 'date'

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Hidden.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Hidden.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Hidden.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Hidden - Add hidden fields to your forms
+
+=head1 METHODS
+
 =head2 type
 
 The HTML input type is C<hidden>.

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/InlineButton.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/InlineButton.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/InlineButton.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,11 @@
 
 use base qw/Jifty::Web::Form::Field::Button/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::InlineButton - Add buttons without a form
+
+=head1 METHODS
 
 =head2 render
 

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Password.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Password.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Password.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Password - Add a password field to your forms
+
+=head1 METHODS
+
 =head2 type
 
 The HTML input type is C<password>.

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Radio.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Radio.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Radio.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Radio - Add a radio button to your forms
+
+=head1 METHODS
+
 =head2 render_widget
 
 Renders the whole radio button collection.

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/ResetButton.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/ResetButton.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/ResetButton.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,11 @@
 
 use base qw/Jifty::Web::Form::Field::InlineButton/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::ResetButton - Add a reset button to your forms
+
+=head1 METHODS
 
 =head2 render_widget
 

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Select.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Select.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Select.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Select - Add a list/popup menu control to your forms
+
+=head1 METHODS
+
 =head2 render_widget
 
 Renders the select widget.

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Text.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Text.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Text.pm	Fri Jul  6 12:36:35 2007
@@ -8,6 +8,8 @@
 
 Jifty::Web::Form::Field::Text - Renders as a small text field
 
+=head1 METHODS
+
 =cut
 
 our $VERSION = 1;

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Textarea.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Textarea.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Textarea.pm	Fri Jul  6 12:36:35 2007
@@ -7,6 +7,12 @@
 
 __PACKAGE__->mk_accessors(qw(rows cols));
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Textarea - Add a multiline text field to your forms
+
+=head1 METHODS
+
 =head2 accessors
 
 Provide C<rows> and C<cols> accessors, in addition to

Modified: jifty/trunk/lib/Jifty/Web/Form/Field/Unrendered.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field/Unrendered.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field/Unrendered.pm	Fri Jul  6 12:36:35 2007
@@ -5,6 +5,12 @@
 
 use base qw/Jifty::Web::Form::Field/;
 
+=head1 NAME
+
+Jifty::Web::Form::Field::Unrendered - Handle unrendered fields
+
+=head1 METHODS
+
 =head2 render
 
 Don't render anything. For one reason or another, this form field should never, ever be rendered, perhaps

Modified: jifty/trunk/lib/Jifty/Web/Menu.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Menu.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Menu.pm	Fri Jul  6 12:36:35 2007
@@ -6,6 +6,12 @@
 
 __PACKAGE__->mk_accessors(qw(label parent sort_order link target escape_label class));
 
+=head1 NAME
+
+Jifty::Web::Menu - Handle the API for menu navigation
+
+=head1 METHODS
+
 =head2 new PARAMHASH
 
 Creates a new L<Jifty::Web::Menu> object.  Possible keys in the


More information about the Jifty-commit mailing list