mambax7 / smartfaq

smartfaq/admin/mygrouppermform.php

Doc Comments +7 added lines

@@ -85,6 +85,10 @@ 
 
     /**
      * Constructor
+     * @param string $title
+     * @param integer $modid
+     * @param string $permname
+     * @param string $permdesc
      */
     function MyXoopsGroupPermForm($title, $modid, $permname, $permdesc)
     {
@@ -117,6 +121,8 @@ 
      * Add appendix
      *
      * @access public
+     * @param string $permName
+     * @param string $itemName
      */
     function addAppendix($permName,$itemId,$itemName)
     {
@@ -249,6 +255,7 @@ 
 
     /**
      * Constructor
+     * @param string $name
      */
     function MyXoopsGroupFormCheckBox($caption, $name, $groupId, $values = null)
     {

smartfaq/class/answer.php

Doc Comments +3 added lines, -6 removed lines

@@ -24,6 +24,7 @@ 
     var $attachment_array = array();
     /**
     * constructor
+    * @param integer $id
     */
     function __construct ($id = null)
     {
@@ -297,7 +298,7 @@ 
     * create a new answer
     *
     * @param bool $isNew flag the new objects as "new"?
-    * @return object sfAnswer
+    * @return sfAnswer sfAnswer
     */
     function &create($isNew = true)
     {
@@ -338,7 +339,7 @@ 
     /**
     * insert a new answer in the database
     *
-    * @param object $answer reference to the {@link sfAnswer} object
+    * @param sfAnswer $answerObj reference to the {@link sfAnswer} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */
@@ -414,8 +415,6 @@ 
     /**
     * delete an answer from the database
     *
-    * @param object $answer reference to the answer to delete
-    * @param bool $force
     * @return bool FALSE if failed.
     */
     function deleteFaqAnswers(&$faqObj)
@@ -476,7 +475,6 @@ 
     /**
     * retrieve 1 official answer (for now SmartFAQ only allow 1 official answer...)
     *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
     * @param int $faqid
     * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
     */
@@ -495,7 +493,6 @@ 
     /**
     * retrieve all answers
     *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
     * @param int $faqid
     * @return array array of {@link sfAnswer} objects
     */

Indentation +73 added lines, -73 removed lines

@@ -23,8 +23,8 @@ 
 {
     var $attachment_array = array();
     /**
-    * constructor
-    */
+     * constructor
+     */
     function __construct ($id = null)
     {
         $this->db =& XoopsDatabaseFactory::getDatabaseConnection();
@@ -184,7 +184,7 @@ 
                 }
                 $post_attachment .= '<br />';
             }
-       }
+        }
 
         return $post_attachment;
     }
@@ -240,7 +240,7 @@ 
 
     function notLoaded()
     {
-       return ($this->getVar('answerid')== -1);
+        return ($this->getVar('answerid')== -1);
     }
 
     function sendNotifications($notifications=array())
@@ -294,11 +294,11 @@ 
 {
 
     /**
-    * create a new answer
-    *
-    * @param bool $isNew flag the new objects as "new"?
-    * @return object sfAnswer
-    */
+     * create a new answer
+     *
+     * @param bool $isNew flag the new objects as "new"?
+     * @return object sfAnswer
+     */
     function &create($isNew = true)
     {
         $answer = new sfAnswer();
@@ -310,11 +310,11 @@ 
     }
 
     /**
-    * retrieve an answer
-    *
-    * @param int $id answerid of the answer
-    * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
-    */
+     * retrieve an answer
+     *
+     * @param int $id answerid of the answer
+     * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
+     */
     function &get($id)
     {
         if (intval($id) > 0) {
@@ -336,12 +336,12 @@ 
     }
 
     /**
-    * insert a new answer in the database
-    *
-    * @param object $answer reference to the {@link sfAnswer} object
-    * @param bool $force
-    * @return bool FALSE if failed, TRUE if already present and unchanged or successful
-    */
+     * insert a new answer in the database
+     *
+     * @param object $answer reference to the {@link sfAnswer} object
+     * @param bool $force
+     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
+     */
     function insert(&$answerObj, $force = false)
     {
         if (strtolower(get_class($answerObj)) != 'sfanswer') {
@@ -384,12 +384,12 @@ 
     }
 
     /**
-    * delete an answer from the database
-    *
-    * @param object $answer reference to the answer to delete
-    * @param bool $force
-    * @return bool FALSE if failed.
-    */
+     * delete an answer from the database
+     *
+     * @param object $answer reference to the answer to delete
+     * @param bool $force
+     * @return bool FALSE if failed.
+     */
     function delete(&$answer, $force = false)
     {
         if (strtolower(get_class($answer)) != 'sfanswer') {
@@ -412,12 +412,12 @@ 
     }
 
     /**
-    * delete an answer from the database
-    *
-    * @param object $answer reference to the answer to delete
-    * @param bool $force
-    * @return bool FALSE if failed.
-    */
+     * delete an answer from the database
+     *
+     * @param object $answer reference to the answer to delete
+     * @param bool $force
+     * @return bool FALSE if failed.
+     */
     function deleteFaqAnswers(&$faqObj)
     {
         if (strtolower(get_class($faqObj)) != 'sffaq') {
@@ -435,12 +435,12 @@ 
     }
 
     /**
-    * retrieve answers from the database
-    *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
-    * @param bool $id_as_key use the answerid as key for the array?
-    * @return array array of {@link sfAnswer} objects
-    */
+     * retrieve answers from the database
+     *
+     * @param object $criteria {@link CriteriaElement} conditions to be met
+     * @param bool $id_as_key use the answerid as key for the array?
+     * @return array array of {@link sfAnswer} objects
+     */
     function &getObjects($criteria = null, $id_as_key = false)
     {
         $ret = array();
@@ -474,12 +474,12 @@ 
     }
 
     /**
-    * retrieve 1 official answer (for now SmartFAQ only allow 1 official answer...)
-    *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
-    * @param int $faqid
-    * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
-    */
+     * retrieve 1 official answer (for now SmartFAQ only allow 1 official answer...)
+     *
+     * @param object $criteria {@link CriteriaElement} conditions to be met
+     * @param int $faqid
+     * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
+     */
     function &getOfficialAnswer($faqid=0)
     {
         $theaAnswers =& $this->getAllAnswers($faqid, _SF_AN_STATUS_APPROVED, 1, 0);
@@ -493,12 +493,12 @@ 
     }
 
     /**
-    * retrieve all answers
-    *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
-    * @param int $faqid
-    * @return array array of {@link sfAnswer} objects
-    */
+     * retrieve all answers
+     *
+     * @param object $criteria {@link CriteriaElement} conditions to be met
+     * @param int $faqid
+     * @return array array of {@link sfAnswer} objects
+     */
     function &getAllAnswers($faqid=0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC')
     {
         $hasStatusCriteria = false;
@@ -531,11 +531,11 @@ 
     }
 
     /**
-    * count answers matching a condition
-    *
-    * @param object $criteria {@link CriteriaElement} to match
-    * @return int count of answers
-    */
+     * count answers matching a condition
+     *
+     * @param object $criteria {@link CriteriaElement} to match
+     * @return int count of answers
+     */
     function getCount($criteria = null)
     {
         $sql = 'SELECT COUNT(*) FROM '.$this->db->prefix('smartfaq_answers');
@@ -552,11 +552,11 @@ 
     }
 
     /**
-    * count answers matching a condition and group by faq ID
-    *
-    * @param object $criteria {@link CriteriaElement} to match
-    * @return array
-    */
+     * count answers matching a condition and group by faq ID
+     *
+     * @param object $criteria {@link CriteriaElement} to match
+     * @return array
+     */
     function getCountByFAQ($criteria = null)
     {
         $sql = 'SELECT faqid, COUNT(*) FROM '.$this->db->prefix('smartfaq_answers');
@@ -580,11 +580,11 @@ 
     }
 
     /**
-    * delete answers matching a set of conditions
-    *
-    * @param object $criteria {@link CriteriaElement}
-    * @return bool FALSE if deletion failed
-    */
+     * delete answers matching a set of conditions
+     *
+     * @param object $criteria {@link CriteriaElement}
+     * @return bool FALSE if deletion failed
+     */
     function deleteAll($criteria = null)
     {
         $sql = 'DELETE FROM '.$this->db->prefix('smartfaq_answers');
@@ -599,14 +599,14 @@ 
     }
 
     /**
-    * Change a value for answers with a certain criteria
-    *
-    * @param   string  $fieldname  Name of the field
-    * @param   string  $fieldvalue Value to write
-    * @param   object  $criteria   {@link CriteriaElement}
-    *
-    * @return  bool
-    **/
+     * Change a value for answers with a certain criteria
+     *
+     * @param   string  $fieldname  Name of the field
+     * @param   string  $fieldvalue Value to write
+     * @param   object  $criteria   {@link CriteriaElement}
+     *
+     * @return  bool
+     **/
     function updateAll($fieldname, $fieldvalue, $criteria = null)
     {
         $set_clause = is_numeric($fieldvalue)? $fieldname.' = '.$fieldvalue : $fieldname.' = '.$this->db->quoteString($fieldvalue);

smartfaq/class/category.php

Doc Comments +2 added lines, -2 removed lines

@@ -228,7 +228,7 @@ 
     * create a new category
     *
     * @param bool $isNew flag the new objects as "new"?
-    * @return object sfCategory
+    * @return sfCategory sfCategory
     */
     function &create($isNew = true)
     {
@@ -270,7 +270,7 @@ 
     /**
     * insert a new category in the database
     *
-    * @param object $category reference to the {@link sfCategory} object
+    * @param sfCategory $category reference to the {@link sfCategory} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

Indentation +50 added lines, -50 removed lines

@@ -24,8 +24,8 @@ 
     var $_groups_admin = null;
 
     /**
-    * constructor
-    */
+     * constructor
+     */
     function __construct($id = null)
     {
         $this->db =& XoopsDatabaseFactory::getDatabaseConnection();
@@ -59,7 +59,7 @@ 
 
     function notLoaded()
     {
-       return ($this->getVar('categoryid')== -1);
+        return ($this->getVar('categoryid')== -1);
     }
 
     function assignOtherProperties()
@@ -160,7 +160,7 @@ 
 
     function setGroups_read($groups_read = array('0'))
     {
-      $this->_groups_read = $groups_read;
+        $this->_groups_read = $groups_read;
     }
 
     function store($sendNotifications = true, $force = true )
@@ -225,11 +225,11 @@ 
 class sfCategoryHandler extends XoopsObjectHandler
 {
     /**
-    * create a new category
-    *
-    * @param bool $isNew flag the new objects as "new"?
-    * @return object sfCategory
-    */
+     * create a new category
+     *
+     * @param bool $isNew flag the new objects as "new"?
+     * @return object sfCategory
+     */
     function &create($isNew = true)
     {
         $category = new sfCategory();
@@ -241,11 +241,11 @@ 
     }
 
     /**
-    * retrieve a category
-    *
-    * @param int $id categoryid of the category
-    * @return mixed reference to the {@link sfCategory} object, FALSE if failed
-    */
+     * retrieve a category
+     *
+     * @param int $id categoryid of the category
+     * @return mixed reference to the {@link sfCategory} object, FALSE if failed
+     */
     function &get($id)
     {
         $false = false;
@@ -268,12 +268,12 @@ 
     }
 
     /**
-    * insert a new category in the database
-    *
-    * @param object $category reference to the {@link sfCategory} object
-    * @param bool $force
-    * @return bool FALSE if failed, TRUE if already present and unchanged or successful
-    */
+     * insert a new category in the database
+     *
+     * @param object $category reference to the {@link sfCategory} object
+     * @param bool $force
+     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
+     */
     function insert(&$category, $force = false)
     {
         if (strtolower(get_class($category)) != 'sfcategory') {
@@ -313,12 +313,12 @@ 
     }
 
     /**
-    * delete a category from the database
-    *
-    * @param object $category reference to the category to delete
-    * @param bool $force
-    * @return bool FALSE if failed.
-    */
+     * delete a category from the database
+     *
+     * @param object $category reference to the category to delete
+     * @param bool $force
+     * @return bool FALSE if failed.
+     */
     function delete(&$category, $force = false)
     {
 
@@ -360,12 +360,12 @@ 
     }
 
     /**
-    * retrieve categories from the database
-    *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
-    * @param bool $id_as_key use the categoryid as key for the array?
-    * @return array array of {@link XoopsFaq} objects
-    */
+     * retrieve categories from the database
+     *
+     * @param object $criteria {@link CriteriaElement} conditions to be met
+     * @param bool $id_as_key use the categoryid as key for the array?
+     * @return array array of {@link XoopsFaq} objects
+     */
     function &getObjects($criteria = null, $id_as_key = false)
     {
         $ret = array();
@@ -476,11 +476,11 @@ 
     }
 
     /**
-    * count Categories matching a condition
-    *
-    * @param object $criteria {@link CriteriaElement} to match
-    * @return int count of categories
-    */
+     * count Categories matching a condition
+     *
+     * @param object $criteria {@link CriteriaElement} to match
+     * @return int count of categories
+     */
     function getCount($criteria = null)
     {
         $sql = 'SELECT COUNT(*) FROM '.$this->db->prefix('smartfaq_categories');
@@ -569,11 +569,11 @@ 
     }
 
     /**
-    * delete categories matching a set of conditions
-    *
-    * @param object $criteria {@link CriteriaElement}
-    * @return bool FALSE if deletion failed
-    */
+     * delete categories matching a set of conditions
+     *
+     * @param object $criteria {@link CriteriaElement}
+     * @return bool FALSE if deletion failed
+     */
     function deleteAll($criteria = null)
     {
         $sql = 'DELETE FROM '.$this->db->prefix('smartfaq_categories');
@@ -590,14 +590,14 @@ 
     }
 
     /**
-    * Change a value for categories with a certain criteria
-    *
-    * @param   string  $fieldname  Name of the field
-    * @param   string  $fieldvalue Value to write
-    * @param   object  $criteria   {@link CriteriaElement}
-    *
-    * @return  bool
-    **/
+     * Change a value for categories with a certain criteria
+     *
+     * @param   string  $fieldname  Name of the field
+     * @param   string  $fieldvalue Value to write
+     * @param   object  $criteria   {@link CriteriaElement}
+     *
+     * @return  bool
+     **/
     function updateAll($fieldname, $fieldvalue, $criteria = null)
     {
         $set_clause = is_numeric($fieldvalue)? $fieldname.' = '.$fieldvalue : $fieldname.' = '.$this->db->quoteString($fieldvalue);

smartfaq/class/faq.php

Doc Comments +4 added lines, -1 removed lines

@@ -207,6 +207,9 @@ 
         return $ret;
     }
 
+    /**
+     * @return integer
+     */
     function uid()
     {
         return $this->getVar("uid");
@@ -619,7 +622,7 @@ 
     /**
     * insert a new faq in the database
     *
-    * @param object $faq reference to the {@link sfFaq} object
+    * @param sfFaq $faq reference to the {@link sfFaq} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

Indentation +43 added lines, -43 removed lines

@@ -70,8 +70,8 @@ 
     var $_smartModule= null;
     var $_smartModuleConfig;
     /**
-    * constructor
-    */
+     * constructor
+     */
     function __construct($id= null)
     {
         $this->db= & XoopsDatabaseFactory::getDatabaseConnection();
@@ -591,11 +591,11 @@ 
     }
 
     /**
-    * retrieve an FAQ
-    *
-    * @param int $id faqid of the user
-    * @return mixed reference to the {@link sfFaq} object, FALSE if failed
-    */
+     * retrieve an FAQ
+     *
+     * @param int $id faqid of the user
+     * @return mixed reference to the {@link sfFaq} object, FALSE if failed
+     */
     function & get($id)
     {
         if (intval($id) > 0) {
@@ -617,12 +617,12 @@ 
     }
 
     /**
-    * insert a new faq in the database
-    *
-    * @param object $faq reference to the {@link sfFaq} object
-    * @param bool $force
-    * @return bool FALSE if failed, TRUE if already present and unchanged or successful
-    */
+     * insert a new faq in the database
+     *
+     * @param object $faq reference to the {@link sfFaq} object
+     * @param bool $force
+     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
+     */
     function insert(& $faq, $force= false)
     {
 
@@ -668,12 +668,12 @@ 
     }
 
     /**
-    * delete an FAQ from the database
-    *
-    * @param object $faq reference to the FAQ to delete
-    * @param bool $force
-    * @return bool FALSE if failed.
-    */
+     * delete an FAQ from the database
+     *
+     * @param object $faq reference to the FAQ to delete
+     * @param bool $force
+     * @return bool FALSE if failed.
+     */
     function delete(& $faq, $force= false)
     {
         $smartModule= & sf_getModuleInfo();
@@ -707,12 +707,12 @@ 
     }
 
     /**
-    * retrieve FAQs from the database
-    *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
-    * @param bool $id_as_key use the faqid as key for the array?
-    * @return array array of {@link sfFaq} objects
-    */
+     * retrieve FAQs from the database
+     *
+     * @param object $criteria {@link CriteriaElement} conditions to be met
+     * @param bool $id_as_key use the faqid as key for the array?
+     * @return array array of {@link sfFaq} objects
+     */
     function & getObjects($criteria= null, $id_as_key= false, $notNullFields= '')
     {
         $ret= array();
@@ -851,11 +851,11 @@ 
     }
 
     /**
-    * count FAQs matching a condition
-    *
-    * @param object $criteria {@link CriteriaElement} to match
-    * @return int count of FAQs
-    */
+     * count FAQs matching a condition
+     *
+     * @param object $criteria {@link CriteriaElement} to match
+     * @return int count of FAQs
+     */
     function getCount($criteria= null, $notNullFields= '')
     {
         $sql= 'SELECT COUNT(*) FROM '.$this->db->prefix('smartfaq_faq');
@@ -1224,11 +1224,11 @@ 
     }
 
     /**
-    * delete FAQs matching a set of conditions
-    *
-    * @param object $criteria {@link CriteriaElement}
-    * @return bool FALSE if deletion failed
-    */
+     * delete FAQs matching a set of conditions
+     *
+     * @param object $criteria {@link CriteriaElement}
+     * @return bool FALSE if deletion failed
+     */
     function deleteAll($criteria= null)
     {
         $sql= 'DELETE FROM '.$this->db->prefix('smartfaq_faq');
@@ -1244,14 +1244,14 @@ 
     }
 
     /**
-    * Change a value for FAQ with a certain criteria
-    *
-    * @param   string  $fieldname  Name of the field
-    * @param   string  $fieldvalue Value to write
-    * @param   object  $criteria   {@link CriteriaElement}
-    *
-    * @return  bool
-    **/
+     * Change a value for FAQ with a certain criteria
+     *
+     * @param   string  $fieldname  Name of the field
+     * @param   string  $fieldvalue Value to write
+     * @param   object  $criteria   {@link CriteriaElement}
+     *
+     * @return  bool
+     **/
     function updateAll($fieldname, $fieldvalue, $criteria= null)
     {
         $set_clause= is_numeric($fieldvalue) ? $fieldname.' = '.$fieldvalue : $fieldname.' = '.$this->db->quoteString($fieldvalue);

smartfaq/class/smartdbupdater.php

Doc Comments +4 added lines, -1 removed lines

@@ -164,6 +164,9 @@ 
         return $fields;
     }
 
+    /**
+     * @param string $field
+     */
     function fieldExists($field)
     {
         $existingFields = $this->getExistingFieldsArray();
@@ -620,7 +623,7 @@ 
    /**
     * Use to update a table
     *
-    * @param object $table {@link SmartDbTable} that will be updated
+    * @param SmartDbTable $table {@link SmartDbTable} that will be updated
     *
     * @see SmartDbTable
     *

Indentation +196 added lines, -196 removed lines

@@ -102,7 +102,7 @@ 
     var $_flagForDrop = false;
 
     /**
- * @var array $_updatedFields containing fields which values will be updated
+     * @var array $_updatedFields containing fields which values will be updated
      */
     var $_updatedFields;
 
@@ -111,24 +111,24 @@ 
      */    //felix
     var $_updatedWhere;
 
-   /**
-    * Constructor
-    *
-    * @param string $name name of the table
-    *
-    */
+    /**
+     * Constructor
+     *
+     * @param string $name name of the table
+     *
+     */
     function __construct($name)
     {
         $this->_name = $name;
         $this->_data = array();
     }
 
-   /**
-    * Return the table name, prefixed with site table prefix
-    *
-    * @return string table name
-    *
-    */
+    /**
+     * Return the table name, prefixed with site table prefix
+     *
+     * @return string table name
+     *
+     */
     function name()
     {
         global $xoopsDB;
@@ -136,12 +136,12 @@ 
         return $xoopsDB->prefix($this->_name);
     }
 
-   /**
-    * Checks if the table already exists in the database
-    *
-    * @return bool TRUE if it exists, FALSE if not
-    *
-    */
+    /**
+     * Checks if the table already exists in the database
+     *
+     * @return bool TRUE if it exists, FALSE if not
+     *
+     */
     function exists()
     {
         return smart_TableExists($this->_name);
@@ -152,13 +152,13 @@ 
         global $xoopsDB;
         $result = $xoopsDB->query("SHOW COLUMNS FROM ".$this->name());
         while ($existing_field = $xoopsDB->fetchArray($result)) {
-             $fields[$existing_field['Field']] = $existing_field['Type'];
-             if ($existing_field['Null'] != "YES") {
-                 $fields[$existing_field['Field']] .= " NOT NULL";
-             }
-             if ($existing_field['Extra']) {
-                 $fields[$existing_field['Field']] .= " ".$existing_field['Extra'];
-             }
+                $fields[$existing_field['Field']] = $existing_field['Type'];
+                if ($existing_field['Null'] != "YES") {
+                    $fields[$existing_field['Field']] .= " NOT NULL";
+                }
+                if ($existing_field['Extra']) {
+                    $fields[$existing_field['Field']] .= " ".$existing_field['Extra'];
+                }
         }
 
         return $fields;
@@ -171,56 +171,56 @@ 
         return isset($existingFields[$field]);
     }
 
-   /**
-    * Set the table structure
-    *
-    * @param  string $structure table structure
-    *
-    */
+    /**
+     * Set the table structure
+     *
+     * @param  string $structure table structure
+     *
+     */
     function setStructure($structure)
     {
         $this->_structure = $structure;
     }
 
     /**
-    * Return the table structure
-    *
-    * @return string table structure
-    *
-    */
+     * Return the table structure
+     *
+     * @return string table structure
+     *
+     */
     function getStructure()
     {
         return sprintf($this->_structure, $this->name());
     }
 
-   /**
-    * Add values of a record to be added
-    *
-    * @param string $data values of a record
-    *
-    */
+    /**
+     * Add values of a record to be added
+     *
+     * @param string $data values of a record
+     *
+     */
     function setData($data)
     {
         $this->_data[] = $data;
     }
 
-   /**
-    * Get the data array
-    *
-    * @return array containing the records values to be added
-    *
-    */
+    /**
+     * Get the data array
+     *
+     * @return array containing the records values to be added
+     *
+     */
     function getData()
     {
         return $this->_data;
     }
 
-   /**
-    * Use to insert data in a table
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to insert data in a table
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function addData()
     {
         global $xoopsDB;
@@ -239,13 +239,13 @@ 
 
     }
 
-   /**
-    * Add a field to be added
-    *
-    * @param string $name name of the field
-    * @param string $properties properties of the field
-    *
-    */
+    /**
+     * Add a field to be added
+     *
+     * @param string $name name of the field
+     * @param string $properties properties of the field
+     *
+     */
     function addAlteredField($name, $properties, $showerror=true)
     {
         $field['name'] = $name;
@@ -255,13 +255,13 @@ 
     }
 
     /**
-    * Invert values 0 to 1 and 1 to 0
-    *
-    * @param string $name name of the field
-    * @param string $old old propertie
-    * @param string $new new propertie
-    *
-    */    //felix
+     * Invert values 0 to 1 and 1 to 0
+     *
+     * @param string $name name of the field
+     * @param string $old old propertie
+     * @param string $new new propertie
+     *
+     */    //felix
     function addUpdatedWhere($name, $newValue, $oldValue)
     {
         $field['name'] = $name;
@@ -270,13 +270,13 @@ 
         $this->_updatedWhere[] = $field;
     }
 
-   /**
-    * Add new field of a record to be added
-    *
-    * @param string $name name of the field
-    * @param string $properties properties of the field
-    *
-    */
+    /**
+     * Add new field of a record to be added
+     *
+     * @param string $name name of the field
+     * @param string $properties properties of the field
+     *
+     */
     function addNewField($name, $properties)
     {
         $field['name'] = $name;
@@ -284,24 +284,24 @@ 
         $this->_newFields[] = $field;
     }
 
-   /**
-    * Get fields that need to be altered
-    *
-    * @return array fields that need to be altered
-    *
-    */
+    /**
+     * Get fields that need to be altered
+     *
+     * @return array fields that need to be altered
+     *
+     */
     function getAlteredFields()
     {
         return $this->_alteredFields;
     }
 
-   /**
-    * Add field for which the value will be updated
-    *
-    * @param string $name name of the field
-    * @param string $value value to be set
-    *
-    */
+    /**
+     * Add field for which the value will be updated
+     *
+     * @param string $name name of the field
+     * @param string $value value to be set
+     *
+     */
     function addUpdatedField($name, $value)
     {
         $field['name'] = $name;
@@ -309,76 +309,76 @@ 
         $this->_updatedFields[] = $field;
     }
 
-   /**
-    * Get new fields to be added
-    *
-    * @return array fields to be added
-    *
-    */
+    /**
+     * Get new fields to be added
+     *
+     * @return array fields to be added
+     *
+     */
     function getNewFields()
     {
         return $this->_newFields;
     }
 
-   /**
-    * Get fields which values need to be updated
-    *
-    * @return array fields which values need to be updated
-    *
-    */
+    /**
+     * Get fields which values need to be updated
+     *
+     * @return array fields which values need to be updated
+     *
+     */
     function getUpdatedFields()
     {
         return $this->_updatedFields;
     }
 
-     /**
-    * Get fields which values need to be updated
-    *
-    * @return array fields which values need to be updated
-    *
-    */    //felix
+        /**
+         * Get fields which values need to be updated
+         *
+         * @return array fields which values need to be updated
+         *
+         */    //felix
     function getUpdatedWhere()
     {
         return $this->_updatedWhere;
     }
 
-   /**
-    * Add values of a record to be added
-    *
-    * @param string $name name of the field
-    *
-    */
+    /**
+     * Add values of a record to be added
+     *
+     * @param string $name name of the field
+     *
+     */
     function addDropedField($name)
     {
         $this->_dropedFields[] = $name;
     }
 
-   /**
-    * Get fields that need to be droped
-    *
-    * @return array fields that need to be droped
-    *
-    */
+    /**
+     * Get fields that need to be droped
+     *
+     * @return array fields that need to be droped
+     *
+     */
     function getDropedFields()
     {
         return $this->_dropedFields;
     }
 
-   /**
-    * Set the flag to drop the table
-    *
-    */
+    /**
+     * Set the flag to drop the table
+     *
+     */
     function setFlagForDrop()
     {
         $this->_flagForDrop = true;
     }
 
-   /**
-    * Use to create a table
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to create a table
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function createTable()
     {
         global $xoopsDB;
@@ -395,12 +395,12 @@ 
         return $ret;
     }
 
-   /**
-    * Use to drop a table
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to drop a table
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function dropTable()
     {
         global $xoopsDB;
@@ -418,12 +418,12 @@ 
         }
     }
 
-   /**
-    * Use to alter a table
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to alter a table
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function alterTable()
     {
         global $xoopsDB;
@@ -446,12 +446,12 @@ 
         return $ret;
     }
 
-   /**
-    * Use to add new fileds in the table
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to add new fileds in the table
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function addNewFields()
     {
         global $xoopsDB;
@@ -471,12 +471,12 @@ 
         return $ret;
     }
 
-   /**
-    * Use to update fields values
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to update fields values
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function updateFieldsValues()
     {
         global $xoopsDB;
@@ -491,16 +491,16 @@ 
             } else {
                 echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . "<br />";
             }
-         }
+            }
 
-         return $ret;
+            return $ret;
     }
-       /**
-    * Use to update fields values
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */        //felix
+        /**
+         * Use to update fields values
+         *
+         * @return bool true if success, false if an error occured
+         *
+         */        //felix
     function updateWhereValues()
     {
         global $xoopsDB;
@@ -516,16 +516,16 @@ 
             } else {
                 echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . "<br />";
             }
-         }
+            }
 
-         return $ret;
+            return $ret;
     }
-   /**
-    * Use to drop fields
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to drop fields
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function dropFields()
     {
         global $xoopsDB;
@@ -564,16 +564,16 @@ 
 
     }
 
-   /**
-    * Use to execute a general query
-    *
-    * @param string $query query that will be executed
-    * @param string $goodmsg message displayed on success
-    * @param string $badmsg message displayed on error
-    *
-    * @return bool true if success, false if an error occured
-    *
-    */
+    /**
+     * Use to execute a general query
+     *
+     * @param string $query query that will be executed
+     * @param string $goodmsg message displayed on success
+     * @param string $badmsg message displayed on error
+     *
+     * @return bool true if success, false if an error occured
+     *
+     */
     function runQuery($query, $goodmsg, $badmsg)
     {
         global $xoopsDB;
@@ -589,14 +589,14 @@ 
         }
     }
 
-   /**
-    * Use to rename a table
-    *
-    * @param string $from name of the table to rename
-    * @param string $to new name of the renamed table
-    *
-    * @return bool true if success, false if an error occured
-    */
+    /**
+     * Use to rename a table
+     *
+     * @param string $from name of the table to rename
+     * @param string $to new name of the renamed table
+     *
+     * @return bool true if success, false if an error occured
+     */
     function renameTable($from, $to)
     {
         global $xoopsDB;
@@ -617,15 +617,15 @@ 
         }
     }
 
-   /**
-    * Use to update a table
-    *
-    * @param object $table {@link SmartDbTable} that will be updated
-    *
-    * @see SmartDbTable
-    *
-    * @return bool true if success, false if an error occured
-    */
+    /**
+     * Use to update a table
+     *
+     * @param object $table {@link SmartDbTable} that will be updated
+     *
+     * @see SmartDbTable
+     *
+     * @return bool true if success, false if an error occured
+     */
     function updateTable($table)
     {
         global $xoopsDB;

smartfaq/class/uploader.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * Constructor
      *
      * @param string $uploadDir
-     * @param array  $allowedMimeTypes
+     * @param integer  $allowedMimeTypes
      * @param int    $maxFileSize
      * @param int    $maxWidth
      * @param int    $maxHeight

Indentation +9 added lines, -9 removed lines

@@ -1,14 +1,14 @@
 <?php
 /**
- * CBB, XOOPS forum module
- *
- * @copyright	The XOOPS Project http://xoops.sf.net
- * @license		http://www.fsf.org/copyleft/gpl.html GNU public license
- * @author		Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
- * @since		4.00
- * @version		$Id $
- * @package		module::newbb
- */
+     * CBB, XOOPS forum module
+     *
+     * @copyright	The XOOPS Project http://xoops.sf.net
+     * @license		http://www.fsf.org/copyleft/gpl.html GNU public license
+     * @author		Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
+     * @since		4.00
+     * @version		$Id $
+     * @package		module::newbb
+     */
 
 // defined("XOOPS_ROOT_PATH") || exit("XOOPS root path not defined");
 

smartfaq/include/functions.php

Doc Comments +3 added lines

@@ -581,6 +581,9 @@
     echo "<h3 style=\"color: #2F5376; margin: 6px 0 0 0; \"><a href='#' onClick=\"toggle('" . $tablename . "'); toggleIcon('" . $iconname . "');\">";
 }
 
+/**
+ * @param string $name
+ */
 function sf_gethandler($name, $optional = false )
 {
     static $handlers;

Indentation +2 added lines, -3 removed lines

@@ -287,8 +287,7 @@ 
 * @param array $groups : group with granted permission
 * @param integer $itemID : faqid on which we are setting permissions
 * @return boolean : TRUE if the no errors occured
-
-*/
+ */
 function sf_saveItemPermissions($groups, $itemID)
 {
     $result = true;
@@ -536,7 +535,7 @@ 
 function sf_collapsableBar($tablename = '', $iconname = '')
 {
 
-   ?>
+    ?>
     <script type="text/javascript"><!--
     function goto_URL(object)
     {

smartfaq/include/functions.render.php

Doc Comments -1 removed lines

@@ -68,7 +68,6 @@
 /**
  * Display forrum button
  *
- * @param	string	$image		image/button name, without extension
  * @param	string	$alt		alt message
  * @param	boolean	$asImage	true for image mode; false for text mode
  * @param	string	$extra		extra attribute for the button

smartfaq/answer.php

Indentation +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
     }
 
     //redirect_header("javascript:history.go(-1)", 3, $redirect_msg);
-     redirect_header("index.php", 3, $redirect_msg);
+        redirect_header("index.php", 3, $redirect_msg);
     exit;
 
     break;