ntentan / honam

src/engines/php/Helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /**
      * A sort of constructor or entry point for helpers.
      * @param mixed $arguments
-     * @return \ntentan\honam\Helper
+     * @return Helper
      */
     public function help($arguments)
     {

src/engines/php/helpers/DateHelper.php

Doc Comments +4 added lines

@@ -229,6 +229,10 @@
         return $englishDate;
     }
     
+    /**
+     * @param double $value
+     * @param boolean $future
+     */
     private function getEnglishDate($timeFrame, $value, $future)
     {
         return ($timeFrame['show_elapsed'] ?  "$value " : '') .

src/engines/php/helpers/feed/generators/RssFeed.php

Doc Comments +3 added lines

@@ -98,6 +98,9 @@
         return $properties[$property];
     }
     
+    /**
+     * @param string $property
+     */
     private function formatProperty($property, $value)
     {
         switch($property)

src/engines/php/helpers/form/CheckableField.php

Doc Comments +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
     /**
      * Sets the value that should be assigned as the checked value for
      * this check box.
-     * @param $checkedValue The value to be assigned.
+     * @param string $checkedValue The value to be assigned.
      * @return Checkbox
      */
     public function setCheckedValue($checkedValue)

src/engines/php/helpers/form/Element.php

Doc Comments +18 added lines, -3 removed lines

@@ -148,7 +148,7 @@ 
     /**
      * Public accessor for setting the name property of the field.
      *
-     * @param  $name The name to assign to the form element.
+     * @param  string $name The name to assign to the form element.
      */
     public function setName($name)
     {
@@ -159,7 +159,7 @@ 
     /**
      * Public accessor for getting the name property of the field.
      *
-     * @return The name of the form field.
+     * @return string name of the form field.
      */
     public function getName()
     {
@@ -167,6 +167,10 @@ 
     }
 
     //! Sets the label which is attached to this element.
+
+    /**
+     * @param string $label
+     */
     public function setLabel($label)
     {
         $this->label = $label;
@@ -194,7 +198,8 @@ 
      * Sets the description which is attached to this element. The description
      * is normally displayed under the element when rendering HTML.
      *
-     * @return string
+     * @param string $description
+     * @return Element
      */
     public function setDescription($description)
     {
@@ -253,6 +258,10 @@ 
     //! This method internally creates a new Attribute object and appends
     //! it to the list of attributes.
     //! \see Attribute
+
+    /**
+     * @param string $attribute
+     */
     public function setAttribute($attribute,$value,$scope = Element::SCOPE_ELEMENT)
     {
         // Force the setting of the attribute.
@@ -282,6 +291,9 @@ 
         return $attributes;
     }
     
+    /**
+     * @param string $attribute
+     */
     public function getAttribute($attribute, $scope = Element::SCOPE_ELEMENT)
     {
         $attributes = $this->getAttributes($scope);
@@ -299,6 +311,9 @@ 
         return $this->renderLabel;
     }
     
+    /**
+     * @param boolean $renderLabel
+     */
     public function setRenderLabel($renderLabel)
     {
         $this->renderLabel = $renderLabel;

Unused Use Statements -1 removed lines

@@ -31,7 +31,6 @@
 
 namespace ntentan\honam\helpers\form;
 
-use ntentan\honam\helpers\FormHelper;
 use ntentan\honam\TemplateEngine;
 
 /**

src/engines/php/helpers/form/Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
     /**
      * Get the value of the field.
      *
-     * @return unknown
+     * @return string
      */
     public function getValue()
     {
@@ -97,7 +97,7 @@ 
     /**
      * Returns the required status of the field.
      *
-     * @return The required status of the field.
+     * @return boolean required status of the field.
      */
     public function getRequired()
     {

src/engines/php/helpers/form/Form.php

Doc Comments +3 added lines

@@ -76,6 +76,9 @@
         );
     }
     
+    /**
+     * @param boolean $showSubmit
+     */
     public function setShowSubmit($showSubmit)
     {
         $this->showSubmit = $showSubmit;

src/engines/php/helpers/ImagesHelper.php

Doc Comments +4 added lines, -1 removed lines

@@ -30,6 +30,10 @@ 
         return $image;
     }
     
+    /**
+     * @param resource $image
+     * @param string $path
+     */
     private function writeImage($image, $path)
     {
     	$array = explode(".", $path);
@@ -115,7 +119,6 @@ 
     /**
      * A smart thumbnailing function. Generates thumbnail images without
      * distorting the output of the final image.
-     * @param string $file
      * @param string $width
      * @param string $height
      * @param string $head

src/engines/php/helpers/ListingHelper.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace ntentan\honam\helpers;
 
-use ntentan\honam\TemplateEngine;
 use ntentan\honam\Helper;
+use ntentan\honam\TemplateEngine;
 
 class ListingHelper extends Helper
 {