adamjakab / SuiteCRM

modules/ACL/ACLController.php

Doc Comments +8 added lines, -1 removed lines

@@ -76,6 +76,9 @@ 
 	}
 	/* END - SECURITY GROUPS */	
 
+	/**
+	 * @param string $value
+	 */
 	static function requireOwner($category, $value, $type='module'){
 			global $current_user;
 			if(is_admin($current_user))return false;
@@ -83,6 +86,10 @@ 
 	}
 
 	/* BEGIN - SECURITY GROUPS */
+
+	/**
+	 * @param string $value
+	 */
 	static function requireSecurityGroup($category, $value, $type='module'){
 			global $current_user;
 			if(is_admin($current_user))return false;
@@ -142,7 +149,7 @@ 
 	 * Check to see if the module is available for this user.
 	 *
 	 * @param String $module_name
-	 * @return true if they are allowed.  false otherwise.
+	 * @return boolean if they are allowed.  false otherwise.
 	 */
 	static function checkModuleAllowed($module_name, $actions)
 	{

modules/ACLActions/ACLAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
      * returns the label  associated with an access level
      * these label definitions  exist in the definitions in modules/ACLActions/actiondefs.php
      * @param INT $access - the access level you want the color for
-     * @return the access level label or false if the level does not exist
+     * @return string|false access level label or false if the level does not exist
      */
     protected static function AccessLabel($access){
         global $ACLActionAccessLevels;

modules/ACLRoles/ACLRole.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
  *
  * Sets the relationship between a role and an action and sets the access level of that relationship
  *
- * @param GUID $role_id - the role id
+ * @param string $role_id - the role id
  * @param GUID $action_id - the ACL Action id
  * @param int $access - the access level ACL_ALLOW_ALL ACL_ALLOW_NONE ACL_ALLOW_OWNER...
  */

modules/Activities/EmailReminder.php

Doc Comments +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
      * @param SugarBean $bean
      * @param Administration $admin
      * @param array $recipients
-     * @return boolean
+     * @return null|boolean
      */
     public function sendReminders(SugarBean $bean, Administration $admin, $recipients)
     {

modules/Administration/Common.php

Doc Comments +8 added lines, -1 removed lines

@@ -74,6 +74,7 @@ 
 /**
  * @return string&
  * @param the_array array, language string, module string
+ * @param string $old_contents
  * @desc Returns the contents of the customized language pack.
  */
 function &create_field_lang_pak_contents($old_contents, $key, $value, $language, $module)
@@ -346,7 +347,7 @@ 
 
 /**
  * @return bool
- * @param dropdown_name string, language string
+ * @param dropdown_name string language string
  * @desc Creates a new dropdown type.
  */
 function create_dropdown_type($dropdown_name, $language)
@@ -549,6 +550,9 @@ 
    save_custom_app_list_strings_contents($new_contents, $language);
 }
 
+/**
+ * @param string $file_contents
+ */
 function replace_or_add_dropdown_type($dropdown_type, &$dropdown_array,
    &$file_contents)
 {
@@ -580,6 +584,9 @@ 
 	return $new_contents;
 }
 
+/**
+ * @param string $file_contents
+ */
 function replace_or_add_app_string($name, $value,
    &$file_contents)
 {

modules/Administration/controller.php

Doc Comments -1 removed lines

@@ -123,7 +123,6 @@
      * to be able to add additional parameters which are currently not supported
      * in the UI (i.e. additional curl settings for elastic search for auth)
      *
-     * @param array $config
      * @return array
      */
     protected function mergeFtsConfig($type, $newConfig)

modules/Administration/DiagnosticRun.php

Doc Comments +3 added lines

@@ -124,6 +124,9 @@
 global $cacheDir;
 $cacheDir = "";
 
+/**
+ * @param integer $itemweight
+ */
 function sodUpdateProgressBar($itemweight){
     global $progress_bar_percent;
     global $totalweight;

modules/Administration/QuickRepairAndRebuild.php

Doc Comments +8 added lines

@@ -47,6 +47,9 @@ 
     public $execute;
     protected $module_list_from_cache;
 
+    /**
+     * @param string[] $selected_actions
+     */
     public function repairAndClearAll($selected_actions, $modules, $autoexecute=false, $show_output=true)
     {
         global $mod_strings;
@@ -446,6 +449,11 @@ 
 	///////////////////////////////////////////////////////////////
 	//// Recursively unlink all files of the given $extension in the given $thedir.
 	//
+
+	/**
+	 * @param string $thedir
+	 * @param string $extension
+	 */
 	private function _clearCache($thedir, $extension)
 	{
         if ($current = @opendir($thedir)) {

modules/Administration/SugarSpriteBuilder.php

Doc Comments +6 added lines, -1 removed lines

@@ -106,7 +106,7 @@ 
      * addDirectory
      *
      * This function is used to create the spriteSrc array
-     * @param $name String value of the sprite name
+     * @param string $name String value of the sprite name
      * @param $dir String value of the directory associated with the sprite entry
      */
 	public function addDirectory($name, $dir) {
@@ -212,6 +212,7 @@ 
      * This is a private helper function to return attributes about an image.  If the width, height or type of the
      * image file cannot be determined, then we do not process the file.
      *
+     * @param string $file
      * @return array of file info entries containing file information (x, y, type) if image type is supported
      */
 	private function getFileInfo($dir, $file) {
@@ -631,6 +632,10 @@ 
 	}
 
 	// helper function to get highest axis value
+
+	/**
+	 * @param string $axis
+	 */
 	function getMaxAxis($axis) {
 		$val = 0;
 		foreach($this->spriteMatrix as $id => $coor) {