supernova-ws / SuperNova

includes/classes/DbRowDirectOperator.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
     return $this->db->doSelectIterator($query);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateRowSetAffected($table, $fieldsAndValues, $where) {
     $this->db->doUpdateRowSet($table, $fieldsAndValues, $where);
     return $this->db->db_affected_rows();

includes/classes/Common/snMath.php

Doc Comments +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
    * @param int  $sigma
    * @param bool $strict
    *
-   * @return int
+   * @return double
    */
   public static function sn_rand_gauss($mu = 0, $sigma = 1, $strict = false) {
     // http://ru.wikipedia.org/wiki/Среднеквадратическое_отклонение
@@ -42,7 +42,7 @@ 
    *
    * @param float      $range_start - Начало диапазона
    * @param float      $range_end - Конец диапазона
-   * @param bool|int   $round - До скольки знаков округлять результат. False - не округлять, True - округлять до целого, 1 - округлять до десятков, 2 - до сотен итд
+   * @param boolean   $round - До скольки знаков округлять результат. False - не округлять, True - округлять до целого, 1 - округлять до десятков, 2 - до сотен итд
    * @param int        $strict - В сколько сигм надо уложить результат
    * @param bool|false $cut_extreme - надо ли обрезать крайние значения. Например, при $strict = 2 их слишком много
    *

includes/general.php

Doc Comments +34 added lines, -3 removed lines

@@ -11,7 +11,7 @@ 
 require_once('general_pname.php');
 
 /**
- * @param       $func_name
+ * @param       string $func_name
  * @param array $func_arg
  *
  * @return mixed
@@ -62,6 +62,9 @@ 
 }
 
 // ----------------------------------------------------------------------------------------------------------------
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename) {
   return @file_get_contents($filename);
 }
@@ -104,7 +107,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -130,7 +133,7 @@ 
  *    - true    - colors number to green if positive or zero; red if negative
  *    - 0
  *    - numeric - colors number to green if less then $color; red if greater
- * @param int|bool  $limit - generally converts "15000" to "15k", "2000000" to "2kk" etc
+ * @param boolean  $limit - generally converts "15000" to "15k", "2000000" to "2kk" etc
  *    - 0/false - proceed with $floor
  *    - numeric - divides number to segments by power of $limit and adds 'k' for each segment
  *        - makes sense for 1000, but works with any number
@@ -229,6 +232,9 @@ 
   return preg_replace($ListCensure, '*', $String);
 }
 
+/**
+ * @param string $email
+ */
 function is_email($email) {
   return (preg_match("/^[-_.[:alnum:]]+@((([[:alnum:]]|[[:alnum:]][[:alnum:]-]*[[:alnum:]])\.)+(ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|at|au|aw|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|com|coop|cr|cs|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gh|gi|gl|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|in|info|int|io|iq|ir|is|it|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mil|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no|np|nr|nt|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)$|(([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5])\.){3}([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5]))$/i", $email));
 }
@@ -266,6 +272,9 @@ 
   return floatval(sys_get_param($param_name, $default));
 }
 
+/**
+ * @param string $param_name
+ */
 function sys_get_param_escaped($param_name, $default = '') {
   return db_escape(sys_get_param($param_name, $default));
 }
@@ -434,6 +443,9 @@ 
 }
 
 // Generates random string of $length symbols from $allowed_chars charset
+/**
+ * @param string $allowed_chars
+ */
 function sys_random_string($length = 16, $allowed_chars = SN_SYS_SEC_CHARS_ALLOWED) {
   $allowed_length = strlen($allowed_chars);
 
@@ -538,6 +550,10 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $title
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   $from = trim($from ? $from : classSupernova::$config->game_adminEmail);
 
@@ -803,6 +819,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -990,6 +1009,9 @@ 
   return $result;
 }
 
+/**
+ * @param string $groups
+ */
 function isInGroup($groups, $unitId) {
   $group = sn_get_groups($groups);
 
@@ -1058,6 +1080,9 @@ 
   return $ranks;
 }
 
+/**
+ * @param boolean $planet_id
+ */
 function sys_player_new_adjust($user_id, $planet_id) { return sn_function_call(__FUNCTION__, array($user_id, $planet_id, &$result)); }
 
 function sn_sys_player_new_adjust($user_id, $planet_id, &$result) {
@@ -1216,6 +1241,9 @@ 
   return $rates;
 }
 
+/**
+ * @param integer $in_resource
+ */
 function get_unit_cost_in(&$cost, $in_resource = RES_METAL) {
   static $rates;
 
@@ -1382,6 +1410,9 @@ 
   return version_compare(sn_version_compare_extra($ver1), sn_version_compare_extra($ver2));
 }
 
+/**
+ * @param string $name
+ */
 function sn_setcookie($name, $value = null, $expire = null, $path = SN_ROOT_RELATIVE, $domain = null, $secure = null, $httponly = null) {
   $_COOKIE[$name] = $value;
 

includes/classes/DbQueryConstructor.php

Doc Comments -2 removed lines

@@ -444,7 +444,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return array
    */
@@ -455,7 +454,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return mixed|null
    */

includes/classes/DBStatic/DBStaticAlly.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
   }
 
   /**
-   * @param $ranklist
+   * @param string $ranklist
    * @param $user
    */
   public static function db_ally_update_ranklist($ranklist, $user) {

includes/classes/DBStatic/DBStaticChat.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
 
   /**
    * @param $user_id
-   * @param $nickUnsafe
+   * @param string $nickUnsafe
    * @param $ally_id
    * @param $message_unsafe
    * @param $chat_message_sender_name_unsafe
@@ -54,7 +54,7 @@ 
    * @param $alliance
    * @param $where_add
    * @param $start_row
-   * @param $page_limit
+   * @param integer $page_limit
    *
    * @return array|bool|mysqli_result|null
    */

includes/classes/DBStatic/DBStaticFleetACS.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 
 
   /**
-   * @param $fleet_group_id_list
+   * @param string $fleet_group_id_list
    */
   public static function db_acs_delete_by_list($fleet_group_id_list) {
     doquery("DELETE FROM {{aks}} WHERE `id` IN ({$fleet_group_id_list})");

includes/classes/DBStatic/DBStaticFleetBashing.php

Doc Comments +1 added lines, -1 removed lines

@@ -5,7 +5,7 @@
   /**
    * @param $user
    * @param $planet_dst
-   * @param $time_limit
+   * @param integer $time_limit
    *
    * @return array|bool|mysqli_result|null
    */

includes/classes/DBStatic/DBStaticFleetMissile.php

Doc Comments +4 added lines

@@ -2,6 +2,10 @@
 
 class DBStaticFleetMissile {
 
+  /**
+   * @param double $arrival
+   * @param integer $target_structure
+   */
   public static function db_missile_insert($target_coord, $user, $planetrow, $arrival, $fleet_ship_count, $target_structure) {
     classSupernova::$db->doInsert(
       "INSERT INTO `{{iraks}}` SET