BurningFlipside / CommonCode

Http/class.WebPage.php

Doc Comments +3 added lines, -1 removed lines

@@ -78,6 +78,9 @@ 
         $this->loader->addPath($dir, $namespace);
     }
 
+    /**
+     * @param string $name
+     */
     public function setTemplateName($name)
     {
         $this->templateName = $name;
@@ -112,7 +115,6 @@ 
      * Add a JavaScript file from a set of files known to the framework
      *
      * @param string $jsFileID the ID of the JS file
-     * @param boolean $async Can the JS file be loaded asynchronously?
      */
     public function addWellKnownJS($jsFileID)
     {

class.FlipsideCAPTCHA.php

Doc Comments +6 added lines

@@ -108,6 +108,9 @@ 
         $this->wwwUrl = $settings->getGlobalSetting('www_url', 'https://www.burningflipside.com');
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getCaptchField($fieldName)
     {
         $dataset = DataSetFactory::getDataSetByName('profiles');
@@ -130,6 +133,9 @@ 
         return $this->getCaptchField('hint');
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         return $this->getCaptchField('answer');

Http/Rest/class.SerializationMiddleware.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
         }
     }
 
+    /**
+     * @param string $param
+     */
     private function getParamFromArrayIfSet($array, $param, $default = null)
     {
         if(isset($array[$param]))

Auth/class.User.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
      *
      * @param stdClass $data The user's new data
      *
-     * @return boolean true if the user's data was changed, false otherwise
+     * @return boolean|null true if the user's data was changed, false otherwise
      */
     public function editUser($data)
     {

Http/Rest/class.DataTableAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Create the DataTableAPI for the given DataTable info
      *
-     * @param string $datSetName The name of the DataSet used in the Settings
+     * @param string $dataSetName The name of the DataSet used in the Settings
      * @param string $dataTableName The name of the table in the DataSet
      * @param string|false $primaryKeyName The table primary key. Must be specified for update/delete capable tables
      */