Ysurac / FlightAirMap

require/libs/Predict/Predict/Sat.php

Doc Comments +7 added lines, -7 removed lines

@@ -124,8 +124,8 @@ 
     }
 
     /** Initialise satellite data.
-     *  @param sat The satellite to initialise.
-     *  @param qth Optional QTH info, use (0,0) if NULL.
+     *  @param sat Predict_Sat satellite to initialise.
+     *  @param qth Predict_QTH QTH info, use (0,0) if NULL.
      *
      * This function calculates the satellite data at t = 0, ie. epoch time
      * The function is called automatically by gtk_sat_data_read_sat.
@@ -216,8 +216,8 @@ 
 
     /** Determinte whether satellite is in geostationary orbit.
      *  @author John A. Magliacane, KD2BD
-     *  @param sat Pointer to satellite data.
-     *  @return TRUE if the satellite appears to be in geostationary orbit,
+     *  @param sat Predict_Sat to satellite data.
+     *  @return boolean if the satellite appears to be in geostationary orbit,
      *          FALSE otherwise.
      *
      * A satellite is in geostationary orbit if
@@ -239,8 +239,8 @@ 
     /** Determine whether satellite has decayed.
      *  @author John A. Magliacane, KD2BD
      *  @author Alexandru Csete, OZ9AEC
-     *  @param sat Pointer to satellite data.
-     *  @return TRUE if the satellite appears to have decayed, FALSE otherwise.
+     *  @param sat Predict_Sat to satellite data.
+     *  @return boolean if the satellite appears to have decayed, FALSE otherwise.
      *  @bug Modified version of the predict code but it is not tested.
      *
      * A satellite is decayed if
@@ -273,7 +273,7 @@ 
      * @param float       $time The daynum the satellite is calculated for
      * @param Predict_QTH $qth  The observer location
      *
-     * @return null on failure, float otherwise
+     * @return null|double on failure, float otherwise
      */
     public function calculateApparentMagnitude($time, Predict_QTH $qth)
     {

require/libs/Predict/Predict/SGPObs.php

Doc Comments +4 added lines

@@ -56,6 +56,10 @@
     /* It is intended to be used to determine the ground track of */
     /* a satellite.  The calculations  assume the earth to be an  */
     /* oblate spheroid as defined in WGS '72.                     */
+
+    /**
+     * @param double $_time
+     */
     public static function Calculate_LatLonAlt($_time, Predict_Vector $pos,  Predict_Geodetic $geodetic)
     {
         /* Reference:  The 1992 Astronomical Almanac, page K12. */

require/libs/Predict/Predict/SGPSDP.php

Doc Comments +12 added lines

@@ -67,6 +67,10 @@ 
     /* structure with Keplerian orbital elements and pos and vel    */
     /* are vector_t structures returning ECI satellite position and */
     /* velocity. Use Convert_Sat_State() to convert to km and km/s.*/
+
+    /**
+     * @param double $tsince
+     */
     public function SGP4(Predict_Sat $sat, $tsince)
     {
         /* Initialization */
@@ -312,6 +316,10 @@ 
     /* structure with Keplerian orbital elements and pos and vel    */
     /* are vector_t structures returning ECI satellite position and */
     /* velocity. Use Convert_Sat_State() to convert to km and km/s. */
+
+    /**
+     * @param double $tsince
+     */
     public function SDP4(Predict_Sat $sat, $tsince)
     {
         /* Initialization */
@@ -538,6 +546,10 @@ 
     /* DEEP */
     /* This function is used by SDP4 to add lunar and solar */
     /* perturbation effects to deep-space orbit objects.    */
+
+    /**
+     * @param integer $ientry
+     */
     public function Deep($ientry, Predict_Sat $sat)
     {
         switch ($ientry) {

require/libs/Predict/Predict/Solar.php

Doc Comments +4 added lines

@@ -51,6 +51,10 @@
     }
 
     /* Calculates stellite's eclipse status and depth */
+
+    /**
+     * @param double $depth
+     */
     public static function Sat_Eclipsed(Predict_Vector $pos, Predict_Vector $sol, &$depth)
     {
         $Rho   = new Predict_Vector();

require/libs/Predict/Predict/Time.php

Doc Comments +22 added lines, -1 removed lines

@@ -36,6 +36,10 @@ 
     /* the year 1999 assuming that two-digit years in the range 00-56   */
     /* correspond to 2000-2056. Until the two-line element set format   */
     /* is changed, it is only valid for dates through 2056 December 31. */
+
+    /**
+     * @param double $epoch
+     */
     public static function Julian_Date_of_Epoch($epoch)
     {
         $year = 0;
@@ -54,6 +58,11 @@ 
     }
 
     /* Equivalent to the C modf function */
+
+    /**
+     * @param double $x
+     * @param integer $ipart
+     */
     public static function modf($x, &$ipart) {
         $ipart = (int)$x;
         return $x - $ipart;
@@ -63,6 +72,10 @@ 
     /* of Day 0.0 of {year}. This function is used to calculate the */
     /* Julian Date of any date by using Julian_Date_of_Year, DOY,   */
     /* and Fraction_of_Day. */
+
+    /**
+     * @param integer $year
+     */
     public static function Julian_Date_of_Year($year)
     {
         /* Astronomical Formulae for Calculators, Jean Meeus, */
@@ -85,6 +98,10 @@ 
     /* 1999, as described above. The function ThetaG_JD provides the   */
     /* same calculation except that it is based on an input in the     */
     /* form of a Julian Date. */
+
+    /**
+     * @param double $epoch
+     */
     public static function ThetaG($epoch, Predict_DeepArg $deep_arg)
     {
         /* Reference:  The 1992 Astronomical Almanac, page B6. */
@@ -157,6 +174,10 @@ 
     /* (approximately the same as UTC) and ET (now referred to as TDT).*/
     /* This function is based on a least squares fit of data from 1950 */
     /* to 1991 and will need to be updated periodically. */
+
+    /**
+     * @param double $year
+     */
     public static function Delta_ET($year)
     {
       /* Values determined using data from 1950-1991 in the 1990
@@ -204,7 +225,7 @@ 
      *
      * @param Predict_TLE $tle The TLE object
      *
-     * @return int
+     * @return double
      */
     public static function getEpochTimeStamp(Predict_TLE $tle)
     {

require/class.NOTAM.php

Doc Comments +14 added lines

@@ -1098,6 +1098,10 @@ 
 		else return array();
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $rules
+	 */
 	public function addNOTAM($ref,$title,$type,$fir,$code,$rules,$scope,$lower_limit,$upper_limit,$center_latitude,$center_longitude,$radius,$date_begin,$date_end,$permanent,$text,$full_notam) {
 		$query = "INSERT INTO notam (ref,title,notam_type,fir,code,rules,scope,lower_limit,upper_limit,center_latitude,center_longitude,radius,date_begin,date_end,permanent,notam_text,full_notam) VALUES (:ref,:title,:type,:fir,:code,:rules,:scope,:lower_limit,:upper_limit,:center_latitude,:center_longitude,:radius,:date_begin,:date_end,:permanent,:text,:full_notam)";
 		$query_values = array(':ref' => $ref,':title' => $title,':type' => $type,':fir' => $fir,':code' => $code,':rules' => $rules,':scope' => $scope,':lower_limit' => $lower_limit,':upper_limit' => $upper_limit,':center_latitude' => $center_latitude,':center_longitude' => $center_longitude,':radius' => $radius,':date_begin' => $date_begin,':date_end' => $date_end,':permanent' => $permanent,':text' => $text,':full_notam' => $full_notam);
@@ -1179,6 +1183,10 @@ 
 			}
 		}
 	}
+
+	/**
+	 * @param string $filename
+	 */
 	public function updateNOTAMfromTextFile($filename) {
 		$alldata = $this->parseNOTAMtextFile($filename);
 		if (count($alldata) > 0) {
@@ -1223,6 +1231,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $icao
+	 */
 	public function downloadNOTAM($icao) {
 		date_default_timezone_set("UTC");
 		$Common = new Common();
@@ -1359,6 +1370,9 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $code
+	 */
 	public function parse_code($code) {
 		$code = str_split($code);
 		$code_fp = $code[1].$code[2];

require/class.SpotterArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
     /**
     * Get SQL query part for filter used
     * @param Array $filter the filter
-    * @return Array the SQL part
+    * @return string the SQL part
     */
     public function getFilter($filter = array(),$where = false,$and = false) {
 	global $globalFilter, $globalStatsFilters, $globalFilterName;

require/class.ATC.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
     /**
     * Get SQL query part for filter used
     * @param Array $filter the filter
-    * @return Array the SQL part
+    * @return string the SQL part
     */
     public function getFilter($filter = array(),$where = false,$and = false) {
 	global $globalFilter, $globalStatsFilters, $globalFilterName;

require/class.Common.php

Doc Comments +9 added lines, -2 removed lines

@@ -79,6 +79,10 @@ 
 		return strlen($headerLine); // Needed by curl
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalDebug;
 		$fp = fopen($file, 'w');
@@ -179,7 +183,7 @@ 
 	* Check is distance realistic
 	* @param int $timeDifference the time between the reception of both messages
 	* @param float $distance distance covered
-	* @return whether distance is realistic
+	* @return boolean distance is realistic
 	*/
 	public function withinThreshold ($timeDifference, $distance) {
 		$x = abs($timeDifference);
@@ -202,6 +206,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -303,7 +310,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{