osCommerce / oscommerce2

catalog/includes/functions/general.php

Doc Comments +14 added lines

@@ -79,6 +79,9 @@ 
 
 ////
 // Break a word in a string if it is longer than a specified length ($len)
+  /**
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -246,6 +249,9 @@ 
 
 ////
 // Wrapper function for round()
+  /**
+   * @return double
+   */
   function tep_round($number, $precision) {
     if (strpos($number, '.') && (strlen(substr($number, strpos($number, '.')+1)) > $precision)) {
       $number = substr($number, 0, strpos($number, '.') + 1 + $precision + 1);
@@ -425,6 +431,11 @@ 
 ////
 // Return a formatted address
 // TABLES: address_format
+  /**
+   * @param boolean $html
+   * @param string $boln
+   * @param string $eoln
+   */
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -918,6 +929,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;

catalog/includes/OSC/OM/Mail.php

Doc Comments +18 added lines

@@ -25,6 +25,9 @@ 
               $content_transfer_encoding = '7bit',
               $charset = 'utf-8';
 
+    /**
+     * @param string $subject
+     */
     public function __construct($to_email_address = null, $to = null, $from_email_address = null, $from = null, $subject = null)
     {
         if (!empty($to_email_address)) {
@@ -95,6 +98,9 @@ 
         $this->setBodyPlain($plain);
     }
 
+    /**
+     * @param string $body
+     */
     public function setBodyPlain($body)
     {
         $this->body_plain = $body;
@@ -117,6 +123,9 @@ 
         $this->charset = $charset;
     }
 
+    /**
+     * @param string $key
+     */
     public function addHeader($key, $value)
     {
         if ((strpos($key, "\n") !== false) || (strpos($key, "\r") !== false)) {
@@ -371,6 +380,9 @@ 
         ini_restore('sendmail_from');
     }
 
+    /**
+     * @param string $file
+     */
     protected function get_mime_type($file)
     {
         $ext = substr($file, strrpos($file, '.') + 1);
@@ -394,6 +406,9 @@ 
         }
     }
 
+    /**
+     * @param string $boundary
+     */
     protected function build_attachment($attachment, $boundary)
     {
         return '--' . $boundary . "\n" .
@@ -403,6 +418,9 @@ 
                 $attachment['data'] . "\n\n";
     }
 
+    /**
+     * @param string $boundary
+     */
     protected function build_image($image, $boundary)
     {
         return '--' . $boundary . "\n" .

catalog/includes/functions/banner.php

Doc Comments +6 added lines

@@ -16,6 +16,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -106,6 +109,9 @@ 
 
 ////
 // Check to see if a banner exists
+  /**
+   * @param string $action
+   */
   function tep_banner_exists($action, $identifier) {
     $OSCOM_Db = Registry::get('Db');