supernova-ws / SuperNova

includes/classes/Fleet.php

Doc Comments +15 added lines, -4 removed lines

@@ -814,6 +814,9 @@ 
     return max(0, $this->shipsGetCapacity() - $this->resourcesGetTotal());
   }
 
+  /**
+   * @param integer $ship_id
+   */
   public function shipsGetTotalById($ship_id) {
     return $this->unitList->unitsCountById($ship_id);
   }
@@ -928,7 +931,7 @@ 
   /**
    * Set current resource list from array of units
    *
-   * @param array $resource_list
+   * @param integer[] $resource_list
    */
   public function resourcesSet($resource_list) {
     if(!empty($this->propertiesAdjusted['resource_list'])) {
@@ -973,7 +976,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -1004,7 +1007,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int
@@ -1055,7 +1057,7 @@ 
   /**
    * @param int $speed_percent
    *
-   * @return array
+   * @return integer
    */
   protected function flt_travel_data($speed_percent = 10) {
     $distance = $this->targetVector->distanceFromCoordinates($this->dbSourcePlanetRow);
@@ -1157,6 +1159,9 @@ 
     }
   }
 
+  /**
+   * @param integer $errorCode
+   */
   public function restrictToTypePlanet($errorCode) {
     if($this->targetVector->type != PT_PLANET) {
       throw new Exception($errorCode, $errorCode);
@@ -2558,6 +2563,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $missionType
+   */
   protected function checkMission($missionType) {
     $result = !$this->_mission_type || $this->_mission_type == $missionType;
     if($result) {
@@ -2571,6 +2579,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $missionType
+   */
   protected function checkMissionNonRestrict($missionType) {
     return $this->_mission_type == $missionType;
   }