[Catalyst-commits] r8144 - Catalyst-Devel/1.10/trunk/lib/Catalyst

[ash at dev.catalyst.perl.org]

Author: ash
Date: 2008-07-21 15:09:49 +0100 (Mon, 21 Jul 2008)
New Revision: 8144

Modified:
   Catalyst-Devel/1.10/trunk/lib/Catalyst/Helper.pm
Log:
Make POD of Catalyst::Helper be more useful to end users

Modified: Catalyst-Devel/1.10/trunk/lib/Catalyst/Helper.pm
===================================================================
--- Catalyst-Devel/1.10/trunk/lib/Catalyst/Helper.pm	2008-07-20 08:11:37 UTC (rev 8143)
+++ Catalyst-Devel/1.10/trunk/lib/Catalyst/Helper.pm	2008-07-21 14:09:49 UTC (rev 8144)
@@ -29,8 +29,59 @@
 
 Bootstrap a Catalyst application. Autogenerates scripts.
 
-=head2 METHODS
+=head1 HELPERS
 
+Helpers are classes that provide two methods.
+
+    * mk_compclass - creates the Component class
+    * mk_comptest  - creates the Component test
+
+So when you call C<bin/create view MyView TT>, create would try to execute
+Catalyst::Helper::View::TT->mk_compclass and
+Catalyst::Helper::View::TT->mk_comptest.
+
+See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::DBIC::Schema>
+for examples.
+
+All helper classes should be under one of the following namespaces.
+
+    Catalyst::Helper::Model::
+    Catalyst::Helper::View::
+    Catalyst::Helper::Controller::
+
+=head2 COMMON HELPERS
+
+=over
+
+=item *
+
+L<Catalyst::Helper::Model::DBIC::Schema> - DBIx::Class models
+
+=item *
+
+L<Catalyst::Helper::View::TT> - Template Toolkit view
+
+=item *
+
+L<Catalyst::Helper::Model::LDAP>
+
+=item *
+
+L<Catalyst::Helper::Model::Adaptor> - wrap any class into a Catalyst model
+
+=back
+
+=head1 NOTE
+
+The helpers will read author name from /etc/passwd by default.
+To override, please export the AUTHOR variable.
+
+
+=head1 INTERAL METHODS
+
+These methods are used when creating new Helpers. If you are just using 
+C<myapp_create.pl> you do not care about this section.
+
 =head3 get_file
 
 Slurp file from DATA.
@@ -496,31 +547,6 @@
     }
 }
 
-=head1 HELPERS
-
-Helpers are classes that provide two methods.
-
-    * mk_compclass - creates the Component class
-    * mk_comptest  - creates the Component test
-
-So when you call C<bin/create view MyView TT>, create would try to execute
-Catalyst::Helper::View::TT->mk_compclass and
-Catalyst::Helper::View::TT->mk_comptest.
-
-See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::DBIC> for
-examples.
-
-All helper classes should be under one of the following namespaces.
-
-    Catalyst::Helper::Model::
-    Catalyst::Helper::View::
-    Catalyst::Helper::Controller::
-
-=head1 NOTE
-
-The helpers will read author name from /etc/passwd by default.
-To override, please export the AUTHOR variable.
-
 =head1 SEE ALSO
 
 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,