osCommerce / oscommerce2

catalog/admin/includes/classes/logger.php

Doc Comments +3 added lines

@@ -45,6 +45,9 @@
       return '<span class="smallText">Parse Time: ' . $this->timer_total . 's</span>';
     }
 
+    /**
+     * @param string $type
+     */
     function write($message, $type) {
       error_log(strftime(STORE_PARSE_DATE_TIME_FORMAT) . ' [' . $type . '] ' . $message . "\n", 3, STORE_PAGE_PARSE_TIME_LOG);
     }

catalog/admin/includes/classes/phplot.php

Doc Comments +78 added lines

@@ -301,6 +301,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $which_input_file
+	 */
 	function SetInputFile($which_input_file) { 
 		//$this->SetFileFormat($which_frmt);
 		$size = GetImageSize($which_input_file);
@@ -343,6 +346,9 @@ 
 
 	}
 
+	/**
+	 * @param string $which_output_file
+	 */
 	function SetOutputFile($which_output_file) { 
 		$this->output_file = $which_output_file;
 		return true;
@@ -719,11 +725,18 @@ 
 			$this->ndx_plot_bg_color);
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetBackgroundColor($which_color) {
 		$this->bg_color= $which_color;
 		$this->ndx_bg_color= $this->SetIndexColor($which_color);
 		return true;
 	}
+
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetPlotBgColor($which_color) {
 		$this->plot_bg_color= $which_color;
 		$this->ndx_plot_bg_color= $this->SetIndexColor($which_color);
@@ -735,36 +748,54 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetTitleColor($which_color) {
 		$this->title_color= $which_color;
 		$this->ndx_title_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetTickColor ($which_color) {
 		$this->tick_color= $which_color;
 		$this->ndx_tick_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetLabelColor ($which_color) {
 		$this->label_color= $which_color;
 		$this->ndx_label_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetTextColor ($which_color) {
 		$this->text_color= $which_color;
 		$this->ndx_text_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetLightGridColor ($which_color) {
 		$this->light_grid_color= $which_color;
 		$this->ndx_light_grid_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetGridColor ($which_color) {
 		$this->grid_color = $which_color;
 		$this->ndx_grid_color= $this->SetIndexColor($which_color);
@@ -997,6 +1028,12 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $x1
+	 * @param string $y1
+	 * @param string $x2
+	 * @param string $y2
+	 */
 	function SetPlotAreaPixels($x1,$y1,$x2,$y2) {
 		//Like in GD 0,0 is upper left
 		if (!$this->x_tot_margin) {
@@ -1017,6 +1054,12 @@ 
 
 	}
 
+	/**
+	 * @param string $xmin
+	 * @param string $ymin
+	 * @param string $xmax
+	 * @param string $ymax
+	 */
 	function SetPlotAreaWorld($xmin,$ymin,$xmax,$ymax) {
 		if (($xmin == "")  && ($xmax == "")) {
 			//For automatic setting of data we need $this->max_x
@@ -1081,6 +1124,9 @@ 
 		die;
 	}
 
+	/**
+	 * @param string $error_message
+	 */
 	function DrawError($error_message) {
 	// prints the error message inline into
 	// the generated image
@@ -1208,6 +1254,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $which_ps
+	 */
 	function SetPointSize($which_ps) {
 		//in pixels
 		SetType($which_ps,'integer');
@@ -1238,6 +1287,9 @@ 
 	}
 
 //////////////COLORS
+	/**
+	 * @param string $which_color_array
+	 */
 	function SetRGBArray ($which_color_array) { 
 		if ( is_array($which_color_array) ) { 
 			//User Defined Array
@@ -1333,6 +1385,10 @@ 
 		return $ret_val;
 	}
 
+	/**
+	 * @param string[] $which_data
+	 * @param string[] $which_border
+	 */
 	function SetDataColors($which_data,$which_border) {
 		//Set the data to be displayed in a particular color
 		if (!$which_data) {
@@ -1833,6 +1889,9 @@ 
 
 	}
 
+	/**
+	 * @param double $xpos
+	 */
 	function DrawXDataLabel($xlab,$xpos) {
 		//xpos comes in in PIXELS not in world coordinates.
 		//Draw an x data label centered at xlab
@@ -2083,6 +2142,9 @@ 
 
 	}  //function DrawThinBarLines
 
+	/**
+	 * @param string $error_bar_type
+	 */
 	function DrawYErrorBar($x_world,$y_world,$error_height,$error_bar_type,$color) {
 		$x1 = $this->xtr($x_world);
 		$y1 = $this->ytr($y_world);
@@ -2105,6 +2167,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $dot_type
+	 */
 	function DrawDot($x_world,$y_world,$dot_type,$color) {
 		$half_point = $this->point_size / 2;
 		$x1 = $this->xtr($x_world) - $half_point;
@@ -2344,6 +2409,14 @@ 
 		return false;
 	} //function DrawLineSeries
 
+	/**
+	 * @param double $x1pix
+	 * @param double $y1pix
+	 * @param double $x2pix
+	 * @param double $y2pix
+	 * @param integer $dash_length
+	 * @param integer $dash_space
+	 */
 	function DrawDashedLine($x1pix,$y1pix,$x2pix,$y2pix,$dash_length,$dash_space,$color) {
 		//Code based on work by Ariel Garza and James Pine
 		//I've decided to have this be in pixels only as a replacement for ImageLine
@@ -2434,6 +2507,11 @@ 
 		}
 	} //function DrawBars
 
+	/**
+	 * @param string $which_x1
+	 * @param string $which_y1
+	 * @param string $which_boxtype
+	 */
 	function DrawLegend($which_x1,$which_y1,$which_boxtype) {
 		//Base code submitted by Marlin Viss
 		$max_legend_length=0;

catalog/admin/includes/classes/upload.php

Doc Comments +12 added lines

@@ -108,10 +108,16 @@ 
       $this->file = $file;
     }
 
+    /**
+     * @param string $destination
+     */
     function set_destination($destination) {
       $this->destination = $destination;
     }
 
+    /**
+     * @param string $permissions
+     */
     function set_permissions($permissions) {
       $this->permissions = octdec($permissions);
     }
@@ -124,6 +130,9 @@ 
       $this->tmp_filename = $filename;
     }
 
+    /**
+     * @param string $extensions
+     */
     function set_extensions($extensions) {
       if (tep_not_null($extensions)) {
         if (is_array($extensions)) {
@@ -160,6 +169,9 @@ 
       }
     }
 
+    /**
+     * @param string $location
+     */
     function set_output_messages($location) {
       switch ($location) {
         case 'session':

catalog/includes/classes/breadcrumb.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
       $this->_trail = array();
     }
 
+    /**
+     * @param string $title
+     */
     function add($title, $link = '') {
       $this->_trail[] = array('title' => $title, 'link' => $link);
     }

catalog/includes/classes/email.php

Doc Comments +4 added lines

@@ -81,6 +81,7 @@ 
  * it. This can then be given as the first
  * argument of the the functions
  * add_html_image() or add_attachment().
+ * @param string $filename
  */
 
     function get_file($filename) {
@@ -151,6 +152,7 @@ 
  * Adds a html part to the mail.
  * Also replaces image names with
  * content-id's.
+ * @param string $text
  */
 
     function add_html($html, $text = NULL, $images_dir = NULL) {
@@ -163,6 +165,7 @@ 
 /**
  * Adds an image to the list of embedded
  * images.
+ * @param string $file
  */
 
     function add_html_image($file, $name = '', $c_type='application/octet-stream') {
@@ -227,6 +230,7 @@ 
 
 /**
  * Adds an alternative part to a mime_part object
+ * @param null|mime $obj
  */
 
     function add_alternative_part(&$obj) {

catalog/includes/classes/http_client.php

Doc Comments +5 added lines, -4 removed lines

@@ -109,7 +109,7 @@ 
 /**
  * addHeader
  * set a unique request header
- * @param headerName the header name
+ * @param headerName string header name
  * @param headerValue the header value, ( unencoded)
  **/
     function addHeader($headerName, $headerValue) {
@@ -119,7 +119,7 @@ 
 /**
  * removeHeader
  * unset a request header
- * @param headerName the header name
+ * @param headerName string header name
  **/
     function removeHeader($headerName) {
       unset($this->requestHeaders[$headerName]);
@@ -307,7 +307,8 @@ 
  * a) the command
  * b) the request headers if they are defined
  * c) the request body if defined
- * @return string the server repsonse status code
+ * @param string $command
+ * @return boolean|null the server repsonse status code
  **/
     function sendCommand($command) {
       $this->responseHeaders = array();
@@ -430,7 +431,7 @@ 
 /**
  * Calculate and return the URI to be sent ( proxy purpose )
  * @param the local URI
- * @return URI to be used in the HTTP request
+ * @return string to be used in the HTTP request
  * @scope private
  **/
     function makeUri($uri) {

catalog/includes/classes/mime.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
  * @param $body   The body of the subpart, if any.
  * @param $params The parameters for the subpart, same
  *                as the $params argument for constructor.
- * @return A reference to the part you just added. It is
+ * @return mime reference to the part you just added. It is
  *         crucial if using multipart/* in your subparts that
  *         you use =& in your script when calling this function,
  *         otherwise you will not be able to add further subparts.

catalog/includes/functions/password_funcs.php

Doc Comments +6 added lines

@@ -13,6 +13,9 @@ 
 ////
 // This function validates a plain text password with a
 // salted or phpass password
+  /**
+   * @param string $plain
+   */
   function tep_validate_password($plain, $encrypted) {
     if (tep_not_null($plain) && tep_not_null($encrypted)) {
       if (tep_password_type($encrypted) == 'salt') {
@@ -52,6 +55,9 @@ 
 ////
 // This function encrypts a phpass password from a plaintext
 // password.
+  /**
+   * @param string $plain
+   */
   function tep_encrypt_password($plain) {
     if (!class_exists('PasswordHash')) {
       include(DIR_WS_CLASSES . 'passwordhash.php');

catalog/includes/functions/specials.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 
 ////
 // Sets the status of a special product
+  /**
+   * @param integer $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     $OSCOM_Db = Registry::get('Db');