silverstripe / silverstripe-multiform

code/model/MultiForm.php

Doc Comments +6 added lines, -5 removed lines

@@ -85,7 +85,7 @@ 
     /**
      * Start the MultiForm instance.
      *
-     * @param Controller instance $controller Controller this form is created on
+     * @param Controller MultiFormTest_Controller $controller Controller this form is created on
      * @param string $name The form name, typically the same as the method name
      */
     public function __construct($controller, $name)
@@ -211,7 +211,7 @@ 
      * Set the step passed in as the current step.
      *
      * @param MultiFormStep $step A subclass of MultiFormStep
-     * @return boolean The return value of write()
+     * @return integer The return value of write()
      */
     protected function setCurrentStep($step)
     {
@@ -300,7 +300,7 @@ 
      * to the database, use {@link getAllStepsLinear()}.
      *
      * @param String $filter SQL WHERE statement
-     * @return DataObjectSet|boolean A set of MultiFormStep subclasses
+     * @return DataList A set of MultiFormStep subclasses
      */
     public function getSavedSteps($filter = null)
     {
@@ -345,6 +345,7 @@ 
      * have created in this method.
      *
      * @param $currentStep Subclass of MultiFormStep
+     * @param MultiFormStep $step
      * @return FieldList of FormAction objects
      */
     public function actionsFor($step)
@@ -384,7 +385,7 @@ 
      * any of those don't exist, look for a default Form template to render
      * with instead.
      *
-     * @return SSViewer object to render the template with
+     * @return HTMLText object to render the template with
      */
     public function forTemplate()
     {
@@ -605,7 +606,7 @@ 
      * session, its used - otherwise a singleton of this step is used.
      * Caution: Doesn't consider branching for steps which aren't in the database yet.
      *
-     * @param $step Subclass of MultiFormStep to find the next step of
+     * @param DataObject $step Subclass of MultiFormStep to find the next step of
      * @param $stepsFound $stepsFound DataObjectSet reference, the steps found to call back on
      * @return DataObjectSet of MultiFormStep instances
      */

code/model/MultiFormStep.php

Doc Comments +2 added lines, -1 removed lines

@@ -104,7 +104,7 @@ 
      * Get a validator specific to this form.
      * The form is automatically validated in {@link Form->httpSubmission()}.
      *
-     * @return Validator
+     * @return boolean
      */
     public function getValidator()
     {
@@ -335,6 +335,7 @@ 
      * Sets the form that this step is directly related to.
      *
      * @param MultiForm subclass $form
+     * @param MultiForm $form
      */
     public function setForm($form)
     {