adamjakab / SuiteCRM

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) {

modules/Administration/UpgradeHistory.php

Doc Comments +11 added lines, -1 removed lines

@@ -86,7 +86,7 @@ 
      * Given a name check if it exists in the table
      * @param name    the unique key from the manifest
      * @param id      the id of the item you are comparing to
-     * @return upgrade_history object if found, null otherwise
+     * @return null|UpgradeHistory object if found, null otherwise
      */
     function checkForExisting($patch_to_check){
         $uh = new UpgradeHistory();
@@ -152,10 +152,16 @@ 
         return $this->getList($query);
     }
 
+    /**
+     * @param string $query
+     */
     function getList($query){
         return( parent::build_related_list( $query, $this ) );
     }
 
+    /**
+     * @param string $var_md5
+     */
     function findByMd5( $var_md5 )
     {
         $query = "SELECT id FROM " . $this->table_name . " where md5sum = '$var_md5'";
@@ -200,6 +206,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $check_path
+     * @param string $recent_path
+     */
     function foundConflict($check_path, $recent_path)
     {
         if(is_file($check_path))

modules/Administration/UpgradeWizardCommon.php

Doc Comments +6 added lines

@@ -83,6 +83,9 @@ 
 
 
 
+/**
+ * @return string
+ */
 function extractFile( $zip_file, $file_in_zip ){
     global $base_tmp_upgrade_dir;
 	if(empty($base_tmp_upgrade_dir)){
@@ -94,6 +97,9 @@ 
     return( "$my_zip_dir/$file_in_zip" );
 }
 
+/**
+ * @return string
+ */
 function extractManifest( $zip_file ){
     return( extractFile( $zip_file, "manifest.php" ) );
 }

modules/AOD_Index/AOD_Index.php

Doc Comments +4 added lines, -1 removed lines

@@ -86,7 +86,7 @@ 
     }
 
     /**
-     * @param $revision
+     * @param SugarBean $revision
      * @return bool|Zend_Search_Lucene_Document
      */
     private function getDocumentForRevision($revision){
@@ -197,6 +197,9 @@ 
         return $document;
     }
 
+    /**
+     * @param string $module
+     */
     private function getBoost($module, $field){
         $fieldBoosts = array('name' =>0.5, 'first_name' => 0.5, 'last_name' => 0.5);
         $moduleBoosts = array('Accounts' => 0.5, 'Contacts' => 0.5, 'Leads' => 0.5, 'Opportunities' => 0.5);

modules/AOD_Index/Lib/Zend/Search/Lucene.php

Doc Comments +3 added lines, -3 removed lines

@@ -200,7 +200,7 @@ 
     /**
      * Create index
      *
-     * @param mixed $directory
+     * @param string $directory
      * @return Zend_Search_Lucene_Interface
      */
     public static function create($directory)
@@ -901,7 +901,7 @@ 
      *
      * Default value is 10
      *
-     * @param integer $maxMergeDocs
+     * @param integer $mergeFactor
      */
     public function setMergeFactor($mergeFactor)
     {
@@ -1547,7 +1547,7 @@ 
     /**
      * Returns term in current position
      *
-     * @return Zend_Search_Lucene_Index_Term|null
+     * @return Zend_Search_Lucene_Index_Term
      */
     public function currentTerm()
     {

modules/AOD_Index/Lib/Zend/Search/Lucene/Analysis/Analyzer.php

Doc Comments -1 removed lines

@@ -147,7 +147,6 @@
     /**
      * Set the default Analyzer implementation used by indexing code.
      *
-     * @param Zend_Search_Lucene_Analysis_Analyzer $similarity
      */
     public static function setDefault(Zend_Search_Lucene_Analysis_Analyzer $analyzer)
     {

modules/AOD_Index/Lib/Zend/Search/Lucene/Analysis/Token.php

Doc Comments +1 added lines, -2 removed lines

@@ -82,7 +82,6 @@ 
      * @param string  $text
      * @param integer $start
      * @param integer $end
-     * @param string  $type
      */
     public function __construct($text, $start, $end)
     {
@@ -128,7 +127,7 @@ 
      * Sets the Token's term text.
      * 
      * @param string $text
-     * @return this
+     * @return Zend_Search_Lucene_Analysis_Token
      */
     public function setTermText($text)
     {

modules/AOD_Index/Lib/Zend/Search/Lucene/Analysis/TokenFilter/ShortWords.php

Doc Comments -1 removed lines

@@ -46,7 +46,6 @@
     /**
      * Constructs new instance of this filter.
      *
-     * @param integer $short  minimum allowed length of term which passes this filter (default 2)
      */
     public function __construct($length = 2) {
         $this->length = $length;