[Jifty-commit] r7159 - jifty/trunk/lib/Jifty/Plugin/SetupWizard

Jifty commits jifty-commit at lists.jifty.org
Tue Jun 2 15:05:27 EDT 2009


Author: sartak
Date: Tue Jun  2 15:05:26 2009
New Revision: 7159

Modified:
   jifty/trunk/lib/Jifty/Plugin/SetupWizard/View.pm

Log:
Doc for SetupWizard::View's functions

Modified: jifty/trunk/lib/Jifty/Plugin/SetupWizard/View.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/SetupWizard/View.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/SetupWizard/View.pm	Tue Jun  2 15:05:26 2009
@@ -125,3 +125,39 @@
 
 1;
 
+__END__
+
+=head1 NAME
+
+Jifty::Plugin::SetupWizard::View - templates for SetupWizard
+
+=head1 FUNCTIONS
+
+=head2 step_link
+
+A helper function for constructing a link to a different step. Expected
+arguments: the C<index> of the step and the C<label> for the link.
+
+=head2 config_field
+
+A helper function for constructing a mini-form for a config field. Expected
+arguments are:
+
+=over 4
+
+=item value_args
+
+The arguments for the C<form_field> call for value. If there's no C<default_value>, one will be constructed using the C<context> parameter.
+
+=item field
+
+=item context
+
+=item target_file
+
+These parameters are for specifying defaults for each action argument.
+
+=back
+
+=cut
+


More information about the Jifty-commit mailing list