From: groditi Date: Tue, 8 Jan 2008 01:52:05 +0000 (+0000) Subject: some boiler plate docs X-Git-Tag: v0.002000~440^2 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=2dba7201f38bfdf9a4132220d98b7691a5f9a257;p=catagits%2FReaction.git some boiler plate docs --- diff --git a/lib/Reaction/UI/ViewPort/Action.pm b/lib/Reaction/UI/ViewPort/Action.pm index c382bdb..1251d8e 100644 --- a/lib/Reaction/UI/ViewPort/Action.pm +++ b/lib/Reaction/UI/ViewPort/Action.pm @@ -204,8 +204,8 @@ Reaction::UI::ViewPort::InterfaceModel::Action =head1 DESCRIPTION -This subclass of viewport is used for rendering a collection of -L objects for user editing. +This subclass of L is used for rendering a +collection of C objects for user editing. =head1 ATTRIBUTES @@ -263,6 +263,8 @@ Attempt to save changes and update C attribute if required. =head1 SEE ALSO +L + L L diff --git a/lib/Reaction/UI/ViewPort/Collection.pm b/lib/Reaction/UI/ViewPort/Collection.pm index a260bd7..eba5f80 100644 --- a/lib/Reaction/UI/ViewPort/Collection.pm +++ b/lib/Reaction/UI/ViewPort/Collection.pm @@ -65,6 +65,49 @@ class Collection is 'Reaction::UI::ViewPort', which { }; +1; +__END__; -1; +=head1 NAME + +Reaction::UI::ViewPort::Collection + +=head1 DESCRIPTION + +Creates, from an InterfaceModel::Collection, a list of viewports representing each +member of the collection. + +=head1 ATTRIBUTES + +=head2 collection + +=head2 current_collection + +=head2 member_args + +=head2 member_class + +=head1 + +=head1 INTERNAL METHODS + +These methods, although stable, are subject to change without notice. These are meant +to be used only by developers. End users should refrain from using these methods to +avoid potential breakages. + +=head2 BUILD + +=head2 get_builder_for + +=head2 model + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/ViewPort/Collection/Grid.pm b/lib/Reaction/UI/ViewPort/Collection/Grid.pm index ab33770..f881ebd 100644 --- a/lib/Reaction/UI/ViewPort/Collection/Grid.pm +++ b/lib/Reaction/UI/ViewPort/Collection/Grid.pm @@ -14,7 +14,7 @@ class Grid is 'Reaction::UI::ViewPort::Collection', which { has computed_field_order => (is => 'ro', isa => 'ArrayRef', lazy_build => 1); #################################### - implements _build_member_class => as { }; + implements _build_member_class => as { Member }; implements _build_field_labels => as { my $self = shift; @@ -55,6 +55,47 @@ class Grid is 'Reaction::UI::ViewPort::Collection', which { }; +1; +__END__; -1; +=head1 NAME + +Reaction::UI::ViewPort::Collection + +=head1 DESCRIPTION + +This subclass of L allows you to display a +homogenous collection of Reaction::InterfaceModel::Objects as a grid. + +=head1 ATTRIBUTES + +=head2 field_order + +=head2 excluded_fields + +=head2 field_labels + +=head2 computed_field_order + +=head1 + +=head1 INTERNAL METHODS + +These methods, although stable, are subject to change without notice. These are meant +to be used only by developers. End users should refrain from using these methods to +avoid potential breakages. + +=head1 SEE ALSO + +L + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/ViewPort/Field.pm b/lib/Reaction/UI/ViewPort/Field.pm index c374eb8..c1c35c8 100644 --- a/lib/Reaction/UI/ViewPort/Field.pm +++ b/lib/Reaction/UI/ViewPort/Field.pm @@ -38,3 +38,34 @@ class Field is 'Reaction::UI::ViewPort', which { }; 1; +__END__; + +=head1 NAME + +Reaction::UI::ViewPort::Field + +=head1 DESCRIPTION + +=head1 ATTRIBUTES + +=head2 model + +=head2 attribute + +=head2 value + +=head2 name + +=head2 label + +=head2 value_string + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/ViewPort/Field/Role/Mutable.pm b/lib/Reaction/UI/ViewPort/Field/Role/Mutable.pm index 8a90ff8..dfad5bb 100644 --- a/lib/Reaction/UI/ViewPort/Field/Role/Mutable.pm +++ b/lib/Reaction/UI/ViewPort/Field/Role/Mutable.pm @@ -49,3 +49,43 @@ role Mutable, which { }; 1; + +=head1 NAME + +Reaction::UI::ViewPort::Role::Actions + +=head1 DESCRIPTION + +A role to ease attaching actions to Ls + +=head1 ATTRIBUTES + +=head2 needs_sync + +=head2 message + +=head2 model + +=head2 attribute + +=head2 value + +=head1 METHODS + +=head2 accept_events + +=head2 sync_from_action + +=head2 sync_to_action + +=head2 adopt_value + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/ViewPort/Object.pm b/lib/Reaction/UI/ViewPort/Object.pm index da45c23..5cd8e5c 100644 --- a/lib/Reaction/UI/ViewPort/Object.pm +++ b/lib/Reaction/UI/ViewPort/Object.pm @@ -181,3 +181,71 @@ class Object is 'Reaction::UI::ViewPort', which { }; 1; + +__END__; + +=head1 NAME + +Reaction::UI::ViewPort::Object + +=head1 DESCRIPTION + +=head1 ATTRIBUTES + +=head2 model + +=head2 fields + +=head2 field_args + +=head2 field_order + +=head2 builder_cache + +=head2 excluded_fields + +=head2 computed_field_order + +=head1 INTERNAL METHODS + +These methods, although stable, are subject to change without notice. These are meant +to be used only by developers. End users should refrain from using these methods to +avoid potential breakages. + +=head2 BUILD + +=head2 get_builder_for + +=head2 _build_simple_field + +=head2 _build_fields_for_type_Num + +=head2 _build_fields_for_type_Int + +=head2 _build_fields_for_type_Bool + +=head2 _build_fields_for_type_Password + +=head2 _build_fields_for_type_Str + +=head2 _build_fields_for_type_SimpleStr + +=head2 _build_fields_for_type_DateTime + +=head2 _build_fields_for_type_Enum + +=head2 _build_fields_for_type_ArrayRef + +=head2 _build_fields_for_type_Reaction_InterfaceModel_Object + +=head2 _build_fields_for_type_Reaction_InterfaceModel_Collection + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/ViewPort/Role/Actions.pm b/lib/Reaction/UI/ViewPort/Role/Actions.pm index 9c99077..f11b7a2 100644 --- a/lib/Reaction/UI/ViewPort/Role/Actions.pm +++ b/lib/Reaction/UI/ViewPort/Role/Actions.pm @@ -30,3 +30,29 @@ role Actions, which { }; 1; + +__END__; + +=head1 NAME + +Reaction::UI::ViewPort::Role::Actions + +=head1 DESCRIPTION + +A role to ease attaching actions to Ls + +=head1 ATTRIBUTES + +=head2 actions + +=head2 action_prototypes + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/Widget/Collection.pm b/lib/Reaction/UI/Widget/Collection.pm index 65e9d64..f219525 100644 --- a/lib/Reaction/UI/Widget/Collection.pm +++ b/lib/Reaction/UI/Widget/Collection.pm @@ -17,3 +17,21 @@ class Collection, which { 1; __END__; + +=head1 NAME + +Reaction::UI::Widget::Collection + +=head1 DESCRIPTION + +=head1 FRAGMENTS + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut diff --git a/lib/Reaction/UI/Widget/Collection/Grid.pm b/lib/Reaction/UI/Widget/Collection/Grid.pm index bf9ad6b..5e05d96 100644 --- a/lib/Reaction/UI/Widget/Collection/Grid.pm +++ b/lib/Reaction/UI/Widget/Collection/Grid.pm @@ -16,3 +16,23 @@ class Grid is 'Reaction::UI::Widget::Collection', which { }; 1; + +__END__; + +=head1 NAME + +Reaction::UI::Widget::Grid + +=head1 DESCRIPTION + +=head1 FRAGMENTS + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +See L for the license. + +=cut