adamjakab / SuiteCRM

modules/Users/User.php

Doc Comments +4 added lines, -9 removed lines

@@ -269,7 +269,7 @@ 
 	 *
 	 * @param string $name Name of the preference to set
 	 * @param string $value Value to set preference to
-	 * @param null $nosession For BC, ignored
+	 * @param integer $nosession For BC, ignored
 	 * @param string $category Name of the category to retrieve
 	 */
 	public function setPreference(
@@ -560,10 +560,6 @@ 
 
 	/**
 	 * @deprecated
-	* @param string $user_name - Must be non null and at least 2 characters
-	* @param string $user_password - Must be non null and at least 1 character.
-	* @desc Take an unencrypted username and password and return the encrypted password
-	* @return string encrypted password for storage in DB and comparison against DB password.
 	*/
 	function encrypt_password($user_password)
 	{
@@ -598,8 +594,8 @@ 
      *
      * @param string id ID of the User
      * @param bool encode encode the result
-     * @return object User bean
-     * @return null null if no User found
+     * @return SugarBean|null User bean
+     * @return SugarBean|null null if no User found
      */
 	function retrieve($id = -1, $encode = true, $deleted = true) {
 		$ret = parent::retrieve($id, $encode, $deleted);
@@ -715,7 +711,7 @@ 
 
 	/**
 	 * Check that md5-encoded password matches existing hash
-	 * @param string $password MD5-encoded password
+	 * @param string $password_md5 MD5-encoded password
 	 * @param string $user_hash DB hash
 	 * @return bool Match or not?
 	 */
@@ -1627,7 +1623,6 @@ 
     /**
      * Get user first day of week.
      *
-     * @param [User] $user user object, current user if not specified
      * @return int : 0 = Sunday, 1 = Monday, etc...
      */
     public function get_first_day_of_week()

include/Pear/XML_HTMLSax3/HTMLSax3/Decorators.php

Doc Comments +11 added lines

@@ -112,6 +112,8 @@ 
     * @param object handler object being decorated
     * @param string original open handler method
     * @param string original close handler method
+    * @param string $orig_open_method
+    * @param string $orig_close_method
     * @access protected
     */
     function __construct(&$orig_obj, $orig_open_method, $orig_close_method) {
@@ -162,6 +164,7 @@ 
     * Constructs XML_HTMLSax3_LineFeed
     * @param object handler object being decorated
     * @param string original handler method
+    * @param string $orig_method
     * @access protected
     */
     function XML_HTMLSax3_LineFeed(&$orig_obj, $orig_method) {
@@ -204,6 +207,7 @@ 
     * Constructs XML_HTMLSax3_Tab
     * @param object handler object being decorated
     * @param string original handler method
+    * @param string $orig_method
     * @access protected
     */
     function __construct(&$orig_obj, $orig_method) {
@@ -247,6 +251,7 @@ 
     * Constructs XML_HTMLSax3_Entities_Parsed
     * @param object handler object being decorated
     * @param string original handler method
+    * @param string $orig_method
     * @access protected
     */
     function __construct(&$orig_obj, $orig_method) {
@@ -271,6 +276,10 @@ 
 * Compatibility with older PHP versions
 */
 if (version_compare(phpversion(), '4.3', '<') && !function_exists('html_entity_decode') ) {
+
+    /**
+     * @param integer $style
+     */
     function html_entity_decode($str, $style=ENT_NOQUOTES) {
         return strtr($str,
             array_flip(get_html_translation_table(HTML_ENTITIES,$style)));
@@ -299,6 +308,7 @@ 
     * Constructs XML_HTMLSax3_Entities_Unparsed
     * @param object handler object being decorated
     * @param string original handler method
+    * @param string $orig_method
     * @access protected
     */
     function __construct(&$orig_obj, $orig_method) {
@@ -342,6 +352,7 @@ 
     * Constructs XML_HTMLSax3_Entities_Unparsed
     * @param object handler object being decorated
     * @param string original handler method
+    * @param string $orig_method
     * @access protected
     */
     function __construct(&$orig_obj, $orig_method) {

include/Popups/PopupSmarty.php

Doc Comments +1 added lines

@@ -123,6 +123,7 @@
      * @param file file Template file to use
      * @param data array from ListViewData
      * @param html_var string the corresponding html var in xtpl per row
+     * @param string $htmlVar
      *
      */
 	function process($file, $data, $htmlVar) {

include/utils/db_utils.php

Doc Comments +2 added lines

@@ -42,6 +42,8 @@
 
 /**
  * @deprecated use DBManager::convert() instead.
+ * @param string $string
+ * @param string $type
  */
 function db_convert($string, $type, $additional_parameters=array(),$additional_parameters_oracle_only=array())
 	{

install/UserDemoData.php

Doc Comments +1 added lines

@@ -180,6 +180,7 @@
 	
 	/**
 	 * 
+	 * @param string $name
 	 */
 	function _quick_create($name)
 	{

modules/ModuleBuilder/MB/MBLanguage.php

Doc Comments +6 added lines

@@ -67,6 +67,9 @@ 
 			$this->generateAppStrings();
 		}
 
+		/**
+		 * @param string $file
+		 */
 		function loadStrings($file)
         {
             $module = strtoupper($this->name);
@@ -90,6 +93,9 @@ 
 			}
 		}
 
+	    /**
+	     * @param string $file
+	     */
 	    function loadAppListStrings($file){
             if(!file_exists($file))return;
 			//we may not need this when loading in the app strings, but there is no harm

modules/ModuleBuilder/MB/MBVardefs.php

Doc Comments +4 added lines

@@ -68,6 +68,10 @@
     }
 
 
+	/**
+	 * @param boolean $by_group
+	 * @param string $file
+	 */
 	function loadTemplate($by_group, $template, $file){
 		$module = $this->name;
 		$table_name = $this->name;