supernova-ws / SuperNova

includes/template.php

Doc Comments +14 added lines, -20 removed lines

@@ -26,7 +26,7 @@ 
  * @param string    $title
  * @param string    $redirectTo
  * @param int       $timeout
- * @param bool|true $showHeader
+ * @param boolean $showHeader
  */
 function messageBox($message, $title = '', $redirectTo = '', $timeout = 5, $showHeader = true) {
   global $lang, $template_result;
@@ -60,6 +60,9 @@ 
   messageBox($message, $title, $redirectTo, $timeout, false);
 }
 
+/**
+ * @param integer $level
+ */
 function messageBoxAdminAccessDenied($level = AUTH_LEVEL_ADMINISTRATOR) {
   global $user, $lang;
 
@@ -215,10 +218,6 @@ 
 /**
  * @param template|string $page
  * @param string          $title
- * @param bool|true       $isDisplayTopNav
- * @param string          $metatags
- * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
  *
  * @return mixed
  */
@@ -233,11 +232,6 @@ 
 /**
  * @param template|string $page
  * @param string          $title
- * @param bool|true       $isDisplayTopNav
- * @param string          $metatags
- * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
- * @param bool|int|string $exitStatus - Код или сообщение выхода
  */
 function sn_display($page, $title = '') {
   global $debug, $user, $planetrow, $config, $lang, $template_result, $sn_mvc, $sn_page_name;
@@ -299,7 +293,7 @@ 
  * @param $page
  * @param $title
  * @param $template_result
- * @param $inLoginLogout
+ * @param boolean $inLoginLogout
  * @param $user
  * @param $config
  * @param $lang
@@ -423,7 +417,7 @@ 
 }
 
 /**
- * @return mixed|string
+ * @return string
  */
 function playerFontSize() {
   $font_size = !empty($_COOKIE[SN_COOKIE_F]) ? $_COOKIE[SN_COOKIE_F] : classSupernova::$user_options[PLAYER_OPTION_BASE_FONT_SIZE];
@@ -458,7 +452,7 @@ 
 /**
  * Checks if minified/full-size CSS file exists - and adds it if any
  *
- * @param $cssFileName
+ * @param string $cssFileName
  * @param &$cssArray
  *
  * @return bool
@@ -531,10 +525,10 @@ 
 
 /**
  * @param $time
- * @param $event
+ * @param integer $event
  * @param $msg
- * @param $prefix
- * @param $is_decrease
+ * @param string $prefix
+ * @param boolean $is_decrease
  * @param $fleet_flying_row
  * @param $fleet_flying_sorter
  * @param $fleet_flying_events
@@ -830,7 +824,7 @@ 
 }
 
 /**
- * @param template|string $template
+ * @param template $template
  */
 function templateRenderToHtml($template) {
   $output = null;
@@ -865,7 +859,7 @@ 
  * @param template $template
  * @param array|bool      $array
  *
- * @return mixed
+ * @return template
  */
 function templateObjectParse($template, $array = false) {
   global $user;
@@ -888,7 +882,7 @@ 
 }
 
 /**
- * @param template|string $template
+ * @param template $template
  * @param array|bool      $array
  *
  * @return mixed
@@ -911,7 +905,7 @@ 
 }
 
 /**
- * @param array|string  $files
+ * @param string  $files
  * @param template|null $template
  * @param string|null   $template_path - path to template
  *

includes/db/db_queries_fleet.php

Doc Comments +2 added lines

@@ -141,6 +141,7 @@ 
  * LIST - Get fleet list by condition
  *
  * @param string $where_safe
+ * @param boolean $for_update
  *
  * @return array[]
  */
@@ -415,6 +416,7 @@ 
  * LIST - Get missile attack list by condition
  *
  * @param string $where
+ * @param boolean $for_update
  *
  * @return array
  */

classes/Account.php

Doc Comments +25 added lines, -1 removed lines

@@ -180,6 +180,10 @@ 
    * @return bool
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   */
   public function db_get_by_name($account_name_unsafe) {
     $this->reset();
 
@@ -218,6 +222,11 @@ 
    *
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $email_unsafe
+   */
   public function db_get_by_name_or_email($account_name_unsafe, $email_unsafe) {
     $this->reset();
 
@@ -254,6 +263,13 @@ 
    * @throws Exception
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $password_raw
+   * @param string $email_unsafe
+   * @param string $language_unsafe
+   */
   public function db_create($account_name_unsafe, $password_raw, $email_unsafe, $language_unsafe = null, $salt_unsafe = null) {
     $this->reset();
 
@@ -348,6 +364,11 @@ 
    * @return int|string
    */
   // OK 4.8
+
+  /**
+   * @param integer $change_type
+   * @param double $metamatter
+   */
   protected function db_mm_log_insert($comment, $change_type, $metamatter, $user_id_unsafe) {
     $provider_id_safe = intval(core_auth::$main_provider->provider_id);
     //$account_id_safe = $this->db->db_escape($this->account_id);
@@ -388,7 +409,7 @@ 
   /**
    * @param int               $change_type
    * @param float             $metamatter
-   * @param string|array|bool $comment
+   * @param string $comment
    * @param bool              $already_changed
    *
    * @return array|bool|int|mysqli_result|null|string
@@ -524,6 +545,9 @@ 
     return false;
   }
 
+  /**
+   * @param string $password
+   */
   protected function password_encode_for_cookie($password) {
     return md5("{$password}--" . $this->secret_word);
   }

includes/db/db_queries_users.php

Doc Comments +2 added lines, -2 removed lines

@@ -6,7 +6,7 @@ 
  * @param int|string $user_id_unsafe
  * @param bool       $for_update
  * @param string     $fields
- * @param null       $player
+ * @param null|boolean       $player
  *
  * @return array|false
  */
@@ -21,7 +21,7 @@ 
   return classSupernova::db_get_user_by_username($username_unsafe, $for_update, $fields, $player, $like);
 }
 /**
- * @param        $username_unsafe
+ * @param        string $username_unsafe
  * @param bool   $for_update
  * @param string $fields
  * @param null   $player

includes/functions/qst_quest.php

Doc Comments +2 added lines, -2 removed lines

@@ -166,7 +166,7 @@ 
 }
 
 /**
- * @param $lang
+ * @param classLocale $lang
  *
  * @return string
  * @throws Exception
@@ -195,7 +195,7 @@ 
 }
 
 /**
- * @param $lang
+ * @param classLocale $lang
  *
  * @return string
  * @throws Exception

classes/Deprecated/PageMercenary.php

Doc Comments +3 added lines

@@ -165,6 +165,9 @@
     display($template, $this->lang['tech'][$this->mode]);
   }
 
+  /**
+   * @param integer $mercenary_id
+   */
   protected function mrc_mercenary_hire($user, $mercenary_id) {
     if (!in_array($mercenary_id, sn_get_groups($this->mode == UNIT_PLANS ? 'plans' : 'mercenaries'))) {
       throw new Exception('mrc_msg_error_wrong_mercenary', ERR_ERROR);

classes/Deprecated/PageFleet5Gathering.php

Doc Comments +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
    * @param array $resources_taken
    * @param array $planet_db_data
    *
-   * @return array
+   * @return double[]
    */
   protected function calcPlanetResources(&$user, $resources_taken, $planet_db_data) {
     $planet_resources = 0;

includes/includes/flt_functions.php

Doc Comments +6 added lines

@@ -1,5 +1,8 @@ 
 <?php
 
+/**
+ * @return double
+ */
 function flt_fleet_speed($user, $fleet)
 {
   if (!is_array($fleet))
@@ -484,6 +487,9 @@ 
 $mission - fleet mission
 */
 
+/**
+ * @param integer $mission
+ */
 function flt_t_send_fleet($user, &$from, $to, $fleet, $mission, $options = array()) {
 //ini_set('error_reporting', E_ALL);
 

includes/functions/eco_get_build_data.php

Doc Comments +5 added lines, -1 removed lines

@@ -10,6 +10,7 @@ 
  *
  * 1.0 - copyright (c) 2010 by Gorlum for http://supernova.ws
  * @version 1.0
+ * @param integer $lab_require
  */
 function eco_get_lab_max_effective_level(&$user, $lab_require)
 {
@@ -67,7 +68,7 @@ 
  * @param array      $user
  * @param array      $planet
  * @param int        $unit_id
- * @param int|string $unit_level
+ * @param integer $unit_level
  * @param bool       $only_cost
  * @param array|null $info
  *
@@ -206,6 +207,9 @@ 
   return $result;
 }
 
+/**
+ * @param integer[] $unit_list
+ */
 function eco_is_builds_in_que($planet_que, $unit_list)
 {
   $eco_is_builds_in_que = false;