Ysurac / FlightAirMap

require/libs/simple_html_dom.php

Doc Comments +40 added lines

@@ -125,6 +125,9 @@ 
 	public $tag_start = 0;
 	private $dom = null;
 
+	/**
+	 * @param simple_html_dom $dom
+	 */
 	function __construct($dom)
 	{
 		$this->dom = $dom;
@@ -1501,6 +1504,11 @@ 
 	}
 
 	// parse attributes
+
+	/**
+	 * @param simple_html_dom_node $node
+	 * @param string[] $space
+	 */
 	protected function parse_attr($node, $name, &$space)
 	{
 		// Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037
@@ -1538,6 +1546,11 @@ 
 	}
 
 	// link node's parent
+
+	/**
+	 * @param simple_html_dom_node $node
+	 * @param boolean $is_child
+	 */
 	protected function link_nodes(&$node, $is_child)
 	{
 		$node->parent = $this->parent;
@@ -1549,6 +1562,10 @@ 
 	}
 
 	// as a text node
+
+	/**
+	 * @param string $tag
+	 */
 	protected function as_text_node($tag)
 	{
 		$node = new simple_html_dom_node($this);
@@ -1559,12 +1576,18 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function skip($chars)
 	{
 		$this->pos += strspn($this->doc, $chars, $this->pos);
 		$this->char = ($this->pos<$this->size) ? $this->doc[$this->pos] : null; // next
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function copy_skip($chars)
 	{
 		$pos = $this->pos;
@@ -1575,6 +1598,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function copy_until($chars)
 	{
 		$pos = $this->pos;
@@ -1584,6 +1610,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $char
+	 */
 	protected function copy_until_char($char)
 	{
 		if ($this->char===null) return '';
@@ -1602,6 +1631,9 @@ 
 		return substr($this->doc, $pos_old, $pos-$pos_old);
 	}
 
+	/**
+	 * @param string $char
+	 */
 	protected function copy_until_char_escape($char)
 	{
 		if ($this->char===null) return '';
@@ -1633,6 +1665,10 @@ 
 
 	// remove noise from html content
 	// save the noise in the $this->noise array.
+
+	/**
+	 * @param string $pattern
+	 */
 	protected function remove_noise($pattern, $remove_tag=false)
 	{
 		global $debug_object;
@@ -1658,6 +1694,10 @@ 
 	}
 
 	// restore noise to html content
+
+	/**
+	 * @param string|null $text
+	 */
 	function restore_noise($text)
 	{
 		global $debug_object;

require/class.Image.php

Doc Comments +3 added lines

@@ -319,6 +319,9 @@
 		return false;
 	}
 
+	/**
+	 * @param string $aircraft_icao
+	 */
 	public function fromIvaoMtl($aircraft_icao,$airline_icao) {
 		$Common = new Common();
 		//echo "\n".'SEARCH IMAGE : http://mtlcatalog.ivao.aero/images/aircraft/'.$aircraft_icao.$airline_icao.'.jpg';

require/class.Connection.php

Doc Comments +16 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 23;
 	
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null,$user = null,$pass = null) {
 	    global $globalDBdriver;
 	    if ($dbc === null) {
@@ -131,6 +134,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -180,6 +186,11 @@ 
 	/*
 	* Check if index exist
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $index
+	 */
 	public function indexExists($table,$index)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -225,6 +236,11 @@ 
 	* Check if a column name exist in a table
 	* @return Boolean column exist or not
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $name
+	 */
 	public function checkColumnName($table,$name)
 	{
 		$query = "SELECT * FROM ".$table." LIMIT 0";

install/class.update_db.php

Doc Comments +42 added lines

@@ -10,6 +10,9 @@ 
 class update_db {
 	public static $db_sqlite;
 
+	/**
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		$fp = fopen($file, 'w+');
 		$ch = curl_init();
@@ -24,6 +27,9 @@ 
 		fclose($fp);
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function gunzip($in_file,$out_file_name = '') {
 		//echo $in_file.' -> '.$out_file_name."\n";
 		$buffer_size = 4096; // read 4kb at a time
@@ -45,6 +51,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function unzip($in_file) {
 		if ($in_file != '' && file_exists($in_file)) {
 			$path = pathinfo(realpath($in_file), PATHINFO_DIRNAME);
@@ -66,6 +75,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -108,6 +120,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_oneworld($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -147,6 +163,9 @@ 
                 return '';
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_skyteam($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -186,6 +205,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -251,6 +274,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -321,6 +347,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -389,6 +418,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -939,6 +971,10 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 * @param string $tletype
+	 */
 	public static function tle($filename,$tletype) {
 		require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1071,6 +1107,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1118,6 +1157,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;

require/libs/Predict/Predict.php

Doc Comments +3 added lines, -17 removed lines

@@ -146,20 +146,6 @@ 
 
     /** Predict first pass after a certain time.
      *
-     *  @param Predict_Sat $sat   The satellite data.
-     *  @param Predict_QTH $qth   The observer's location data.
-     *  @param float       $start Starting time.
-     *  @param int         $maxdt The maximum number of days to look ahead (0 for no limit).
-     *
-     *  @return Predict_Pass or NULL if there was an error.
-     *
-     * This function will find the first upcoming pass with AOS no earlier than
-     * t = start and no later than t = (start+maxdt).
-     *
-     *  note For no time limit use maxdt = 0.0
-     *
-     *  note the data in sat will be corrupt (future) and must be refreshed
-     *       by the caller, if the caller will need it later on
      */
     public function get_pass(Predict_Sat $sat_in, Predict_QTH $qth, $start, $maxdt)
     {
@@ -407,7 +393,7 @@ 
      *  @param Predict_QTH $qth   The observer's location (QTH) data.
      *  @param float       $start The julian date where calculation should start.
      *  @param int         $maxdt The upper time limit in days (0.0 = no limit)
-     *  @return The julain date of the next AOS or 0.0 if the satellite has no AOS.
+     *  @return double julain date of the next AOS or 0.0 if the satellite has no AOS.
      *
      * This function finds the time of AOS for the first coming pass taking place
      * no earlier that start.
@@ -563,7 +549,7 @@ 
      *  @param Predict_QTH $qth The QTH observer location data.
      *  @param float       $start The time where calculation should start. (Julian Date)
      *  @param int         $maxdt The upper time limit in days (0.0 = no limit)
-     *  @return The time (julian date) of the next LOS or 0.0 if the satellite has no LOS.
+     *  @return double time (julian date) of the next LOS or 0.0 if the satellite has no LOS.
      *
      * This function finds the time of LOS for the first coming pass taking place
      * no earlier that start.
@@ -648,7 +634,7 @@ 
      *  @param Predict_Sat $sat   The satellite to find AOS for.
      *  @param Predict_QTH $qth   The ground station.
      *  @param float       $start Start time, prefereably now.
-     *  @return The time of the previous AOS or 0.0 if the satellite has no AOS.
+     *  @return double time of the previous AOS or 0.0 if the satellite has no AOS.
      *
      * This function can be used to find the AOS time in the past of the
      * current pass.

require/libs/Predict/Predict/Math.php

Doc Comments +16 added lines

@@ -42,6 +42,10 @@ 
     }
 
     /* Returns arccosine of rgument */
+
+    /**
+     * @param double $arg
+     */
     public static function ArcCos($arg)
     {
         return Predict::pio2 - self::ArcSin($arg);
@@ -68,6 +72,10 @@ 
     }
 
     /* Multiplies the vector v1 by the scalar k to produce the vector v2 */
+
+    /**
+     * @param integer $k
+     */
     public static function Scalar_Multiply($k, Predict_Vector $v1, Predict_Vector $v2)
     {
         $v2->x = $k * $v1->x;
@@ -155,6 +163,10 @@ 
     }
 
     /* Returns arg1 mod arg2 */
+
+    /**
+     * @param double $arg1
+     */
     public static function Modulus($arg1, $arg2)
     {
         $ret_val  = $arg1;
@@ -169,6 +181,10 @@ 
     }
 
     /* Returns fractional part of double argument */
+
+    /**
+     * @param double $arg
+     */
     public static function Frac($arg)
     {
         return $arg - floor($arg);

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) {