osCommerce / oscommerce2

catalog/admin/includes/functions/html_output.php

Doc Comments +22 added lines

@@ -109,6 +109,9 @@ 
 ////
 // The HTML form submit button wrapper function
 // Outputs a button in the selected language
+  /**
+   * @param string $image
+   */
   function tep_image_submit($image, $alt = '', $parameters = '') {
     global $language;
 
@@ -176,6 +179,9 @@ 
 
 ////
 // Output a form
+  /**
+   * @param string $name
+   */
   function tep_draw_form($name, $action, $parameters = '', $method = 'post', $params = '') {
     $form = '<form name="' . tep_output_string($name) . '" action="';
     if (tep_not_null($parameters)) {
@@ -238,6 +244,9 @@ 
 
 ////
 // Output a selection field - alias function for tep_draw_checkbox_field() and tep_draw_radio_field()
+  /**
+   * @param string $type
+   */
   function tep_draw_selection_field($name, $type, $value = '', $checked = false, $compare = '') {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -256,6 +265,9 @@ 
 
 ////
 // Output a form checkbox field
+  /**
+   * @param string $name
+   */
   function tep_draw_checkbox_field($name, $value = '', $checked = false, $compare = '') {
     return tep_draw_selection_field($name, 'checkbox', $value, $checked, $compare);
   }
@@ -269,6 +281,10 @@ 
 ////
 // Output a form textarea field
 // The $wrap parameter is no longer used in the core xhtml template
+  /**
+   * @param string $name
+   * @param string|false $wrap
+   */
   function tep_draw_textarea_field($name, $wrap, $width, $height, $text = '', $parameters = '', $reinsert_value = true) {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -365,6 +381,12 @@ 
 
 ////
 // Output a jQuery UI Button
+  /**
+   * @param string $title
+   * @param string $icon
+   * @param string $link
+   * @param string $priority
+   */
   function tep_draw_button($title = null, $icon = null, $link = null, $priority = null, $params = null) {
     static $button_counter = 1;
 

catalog/includes/apps/paypal/modules/DP/DP.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
       return $this->doMigrationCheck($this->_pm_code) || $this->doMigrationCheck($this->_pm_pf_code);
     }
 
+    /**
+     * @param string $class
+     */
     function doMigrationCheck($class) {
       if ( file_exists(DIR_FS_CATALOG . 'includes/modules/payment/' . $class . '.php') ) {
         if ( !class_exists($class) ) {

catalog/includes/classes/hooks.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
       $this->register('global');
     }
 
+    /**
+     * @param string $group
+     */
     function register($group) {
       $group = basename($group);
 

catalog/includes/classes/http_client.php

Doc Comments +6 added lines, -4 removed lines

@@ -110,7 +110,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) {
@@ -120,7 +120,7 @@ 
 /**
  * removeHeader
  * unset a request header
- * @param headerName the header name
+ * @param headerName string header name
  **/
     function removeHeader($headerName) {
       unset($this->requestHeaders[$headerName]);
@@ -172,6 +172,7 @@ 
  * get
  * issue a GET http request
  * @param uri URI (path on server) or full URL of the document
+ * @param string $url
  * @return string response status code (200 if ok)
  * @seeAlso getHeaders(), getBody()
  **/
@@ -309,7 +310,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();
@@ -433,7 +435,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/functions/banner.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 
 ////
 // Sets the status of a banner
+  /**
+   * @param string $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     if ($status == '1') {
       return tep_db_query("update " . TABLE_BANNERS . " set status = '1', date_status_change = now(), date_scheduled = NULL where banners_id = '" . (int)$banners_id . "'");

catalog/includes/functions/compatibility.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
   }
 
   if (!function_exists('checkdnsrr')) {
+
+    /**
+     * @param string $type
+     */
     function checkdnsrr($host, $type) {
       if(tep_not_null($host) && tep_not_null($type)) {
         @exec("nslookup -type=" . escapeshellarg($type) . " " . escapeshellarg($host), $output);

catalog/includes/functions/html_output.php

Doc Comments +22 added lines

@@ -117,6 +117,9 @@ 
 ////
 // The HTML form submit button wrapper function
 // Outputs a button in the selected language
+  /**
+   * @param string $image
+   */
   function tep_image_submit($image, $alt = '', $parameters = '') {
     global $language;
 
@@ -147,6 +150,9 @@ 
 
 ////
 // Output a form
+  /**
+   * @param string $name
+   */
   function tep_draw_form($name, $action, $method = 'post', $parameters = '', $tokenize = false) {
     global $sessiontoken;
 
@@ -197,6 +203,9 @@ 
 
 ////
 // Output a selection field - alias function for tep_draw_checkbox_field() and tep_draw_radio_field()
+  /**
+   * @param string $type
+   */
   function tep_draw_selection_field($name, $type, $value = '', $checked = false, $parameters = '') {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -217,6 +226,9 @@ 
 
 ////
 // Output a form checkbox field
+  /**
+   * @param string $name
+   */
   function tep_draw_checkbox_field($name, $value = '', $checked = false, $parameters = '') {
     return tep_draw_selection_field($name, 'checkbox', $value, $checked, $parameters);
   }
@@ -230,6 +242,10 @@ 
 ////
 // Output a form textarea field
 // The $wrap parameter is no longer used in the core xhtml template
+  /**
+   * @param string $name
+   * @param string|false $wrap
+   */
   function tep_draw_textarea_field($name, $wrap, $width, $height, $text = '', $parameters = '', $reinsert_value = true) {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -337,6 +353,12 @@ 
 
 ////
 // Output a jQuery UI Button
+  /**
+   * @param string $title
+   * @param string $icon
+   * @param string $link
+   * @param string $priority
+   */
   function tep_draw_button($title = null, $icon = null, $link = null, $priority = null, $params = null) {
     static $button_counter = 1;
 

catalog/includes/functions/specials.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 
 ////
 // Sets the status of a special product
+  /**
+   * @param string $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     return tep_db_query("update " . TABLE_SPECIALS . " set status = '" . (int)$status . "', date_status_change = now() where specials_id = '" . (int)$specials_id . "'");
   }

catalog/includes/modules/content/login/cm_paypal_login.php

Doc Comments +3 added lines

@@ -312,6 +312,9 @@
       return array('OSCOM_APP_PAYPAL_LOGIN_CONTENT_WIDTH', 'OSCOM_APP_PAYPAL_LOGIN_SORT_ORDER');
     }
 
+    /**
+     * @param string $attribute
+     */
     function hasAttribute($attribute) {
       return in_array($attribute, explode(';', OSCOM_APP_PAYPAL_LOGIN_ATTRIBUTES));
     }