adamjakab / SuiteCRM

include/ytree/Node.php

Doc Comments +8 added lines

@@ -73,6 +73,10 @@ 
 	//node.data object in javascript.
 	//users can add a collection of paramaters that will
 	//be passed to objects responding to tree events
+
+ 	/**
+ 	 * @param string $name
+ 	 */
  	function set_property($name, $value, $is_param=false) {
  		if(!empty($name) && ($value === 0 || !empty($value))) {
  			if ($is_param==false) {
@@ -84,6 +88,10 @@ 
  	}
  	
 	//add a child node.
+
+ 	/**
+ 	 * @param Node $node
+ 	 */
  	function add_node($node) {
   		$this->nodes[$node->uid]=$node;
   	}

install/install_utils.php

Doc Comments +37 added lines, -2 removed lines

@@ -56,6 +56,7 @@ 
  * Calls a custom function (if it exists) based on the first parameter,
  *   and returns result of function call, or 'undefined' if the function doesn't exist
  * @param string function name to call in custom install hooks
+ * @param string $function_name
  * @return mixed function call result, or 'undefined'
  */
 function installerHook($function_name, $options = array()){
@@ -1267,6 +1268,9 @@ 
     return $ret_val;
 }
 
+/**
+ * @param string $start_file
+ */
 function recursive_make_writable($start_file)
     {
     $ret_val = make_writable($start_file);
@@ -1366,6 +1370,9 @@ 
 }
 
 
+/**
+ * @param string $name
+ */
 function print_debug_array( $name, $debug_array ){
     ksort( $debug_array );
 
@@ -1537,7 +1544,7 @@ 
  * it will addd to the return array
  *
  * @param intput_array haystack to check
- * @param needles list of needles to search for
+ * @param needles string[] of needles to search for
  * @param output_array the array to add the keys to
  */
 function copyFromArray($input_array, $needles, $output_array){
@@ -1555,7 +1562,7 @@ 
  * puts it into the cache/upload dir to be handed off to langPackUnpack();
  *
  * @param object file UploadFile object
- * @return bool true if successful
+ * @return null|boolean true if successful
  */
 function langPackFinalMove($file) {
     global $sugar_config;
@@ -1567,6 +1574,12 @@ 
     return true;
 }
 
+/**
+ * @param string $type
+ * @param string $manifest
+ * @param string $license_file
+ * @param string $clean_file
+ */
 function getLicenseDisplay($type, $manifest, $zipFile, $next_step, $license_file, $clean_file) {
     return PackageManagerDisplay::getLicenseDisplay($license_file, 'install.php', $next_step, $zipFile, $type, $manifest, $clean_file);
 }
@@ -1578,6 +1591,8 @@ 
  * @param string manifest path to manifest file
  * @param string zipFile path to uploaded zip file
  * @param int nextstep current step
+ * @param string $type
+ * @param string $manifest
  * @return string ret <form> for this package
  */
 function getPackButton($type, $manifest, $zipFile, $next_step, $uninstallable='Yes', $showButtons=true) {
@@ -1749,6 +1764,9 @@ 
 }
 
 if ( !function_exists('extractFile') ) {
+/**
+ * @return string
+ */
 function extractFile( $zip_file, $file_in_zip, $base_tmp_upgrade_dir){
     $my_zip_dir = mk_temp_dir( $base_tmp_upgrade_dir );
     unzip_file( $zip_file, $file_in_zip, $my_zip_dir );
@@ -1757,6 +1775,9 @@ 
 }
 
 if ( !function_exists('extractManifest') ) {
+/**
+ * @return string
+ */
 function extractManifest( $zip_file,$base_tmp_upgrade_dir ) {
     return( extractFile( $zip_file, "manifest.php",$base_tmp_upgrade_dir ) );
 }
@@ -1997,6 +2018,10 @@ 
 }
 
 
+/**
+ * @param integer $quantity
+ * @param string $string
+ */
 function add_digits($quantity, &$string, $min = 0, $max = 9) {
     for($i=0; $i < $quantity; $i++) {
         $string .= mt_rand($min,$max);
@@ -2014,6 +2039,11 @@ 
     return $phone;
 }
 
+/**
+ * @param integer $year
+ * @param integer $mnth
+ * @param integer $day
+ */
 function create_date($year=null,$mnth=null,$day=null)
 {
     global $timedate;
@@ -2028,6 +2058,11 @@ 
     return $timedate->nowDb();
 }
 
+/**
+ * @param integer $hr
+ * @param integer $min
+ * @param integer $sec
+ */
 function create_time($hr=null,$min=null,$sec=null)
 {
     global $timedate;

install/installConfig.php

Doc Comments +12 added lines, -6 removed lines

@@ -85,6 +85,9 @@ 
 class InstallLayout
 {
 
+    /**
+     * @param string $name
+     */
     public static function getSelect($name, $options, $default) {
         $out = "<select name=\"$name\">";
         foreach($options as $key => $value) {
@@ -117,7 +120,7 @@ 
 
     /**
      * @param $title page title
-     * @param $styles linked css files (string)
+     * @param string $styles linked css files (string)
      * @param $scripts linked javascript files (string)
      * @return string Install page layout header
      */
@@ -138,11 +141,11 @@ 
 
 
     /**
-     * @param $name form tag name
-     * @param $id form tag id
+     * @param string $name form tag name
+     * @param string $id form tag id
      * @param $errs form errors
      * @param $title form header line
-     * @param $items form items (string)
+     * @param string $items form items (string)
      * @param $controlls form controll buttons (string)
      * @return string
      */
@@ -178,8 +181,8 @@ 
 
 
     /**
-     * @param $header install page head
-     * @param $form install page form step
+     * @param string $header install page head
+     * @param string $form install page form step
      * @return string install page
      */
     private function getOutput($header, $form, $sugar_md, $mod_strings)
@@ -1088,6 +1091,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $formId
+     */
     private function getFormControlls($mod_strings, $formId) {
         $out =<<<EOQ
         <div id="checkingDiv" style="display:none">

install/installHelp.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
    return $str;
 }
 
+/**
+ * @param HelpItem[] $help_items
+ */
 function &format_help_items(&$help_items)
 {
    $str = '<table>';

install/TeamDemoData.php

Doc Comments +1 added lines

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

install/UserDemoData.php

Doc Comments +2 added lines

@@ -64,6 +64,7 @@ 
 
 	/**
 	 * Constructor for creating user demo data
+	 * @param integer $seed_user
 	 */
 	function UserDemoData($seed_user, $large_scale_test = false)
 	{
@@ -163,6 +164,7 @@ 
 
 	/**
 	 *
+	 * @param string $name
 	 */
 	function _quick_create_user($name)
 	{

jssource/jsmin.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,8 +13,8 @@
      * line and mult-line comments. Pass 2 performs some sanitation on each of the lines
      * and pass 3 works on stripping out unnecessary spaces.
      *
-     * @param string $js
-     * @param string $currentOptions
+     * @param string $text
+     * @param string $compression
      * @return void
      */
     private function __construct($text, $compression) {

jssource/Minifier.php

Doc Comments +2 added lines

@@ -361,6 +361,7 @@ 
      * Pushes the index ahead to the next instance of the supplied string. If it is found the first character of the
      * string is returned.
      *
+     * @param string $string
      * @return string|false Returns the first character of the string if found, false otherwise.
      */
     protected function getNext($string)
@@ -449,6 +450,7 @@ 
     /**
      * Checks to see if a character is alphanumeric.
      *
+     * @param string|false $char
      * @return bool
      */
     static protected function isAlphaNumeric($char)

jssource/minify_utils.php

Doc Comments +11 added lines

@@ -81,6 +81,10 @@ 
      * and places the concatenated file in root directory
      * @from_path root directory where processing should take place
      */
+
+    /**
+     * @param string $from_path
+     */
     function ConcatenateFiles($from_path){
 
         // Minifying the group files takes a long time sometimes.
@@ -205,6 +209,9 @@ 
 
     }
 
+    /**
+     * @param string $bu_path
+     */
     function create_backup_folder($bu_path){
         $bu_path = str_replace('\\', '/', $bu_path);
         //get path after root
@@ -244,6 +251,10 @@ 
      * @from_path file name and path to be processed
      * @to_path file name and path to be  used to place newly compressed contents
      */
+
+    /**
+     * @param string $from_path
+     */
     function CompressFiles($from_path,$to_path){
     if(!defined('JSMIN_AS_LIB')){
         define('JSMIN_AS_LIB', true);