supernova-ws / SuperNova

includes/classes/Fleet.php

Doc Comments +9 added lines, -4 removed lines

@@ -819,6 +819,9 @@ 
     return max(0, $this->shipsGetCapacity() - $this->resourcesGetTotal());
   }
 
+  /**
+   * @param integer $ship_id
+   */
   public function shipsGetTotalById($ship_id) {
     return $this->unitList->unitsCountById($ship_id);
   }
@@ -933,7 +936,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'])) {
@@ -978,7 +981,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -1009,7 +1012,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int
@@ -1060,7 +1062,7 @@ 
   /**
    * @param int $speed_percent
    *
-   * @return array
+   * @return integer
    */
   protected function flt_travel_data($speed_percent = 10) {
     $distance = $this->targetVector->distanceFromCoordinates($this->dbSourcePlanetRow);
@@ -1161,6 +1163,9 @@ 
     }
   }
 
+  /**
+   * @param integer $errorCode
+   */
   public function restrictToTypePlanet($errorCode) {
     if($this->targetVector->type != PT_PLANET) {
       throw new Exception($errorCode, $errorCode);

includes/classes/UnitList.php

Doc Comments +4 added lines

@@ -324,6 +324,10 @@
    * @return int|mixed
    */
   // TODO - REDO!!!!
+
+  /**
+   * @return double
+   */
   function flt_fleet_speed($user) {
     $speeds = array();
     if(!empty($this->mapUnitIdToDb)) {