Ysurac / FlightAirMap

require/class.APRS.php

Doc Comments +7 added lines

@@ -88,6 +88,10 @@ 
 	'y' => 'Yagi At QTH');
 	
 
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
 	    (($n & 0x7fffffff) >> $s) | 
@@ -442,6 +446,9 @@ 
 	}
     }
     
+    /**
+     * @param string $data
+     */
     function send($data) {
 	$send = socket_send( $this->socket  , $data , strlen($data),0);
 	if ($send === FALSE) $this->connect();

require/class.Common.php

Doc Comments +12 added lines, -2 removed lines

@@ -90,6 +90,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');
@@ -190,7 +194,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);
@@ -213,6 +217,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -224,6 +231,9 @@ 
 		return $deg+(($min*60)/3600);
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -352,7 +362,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.Marine.php

Doc Comments +2 added lines, -21 removed lines

@@ -15,7 +15,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) {
@@ -552,25 +552,6 @@ 
 	*
 	* @param String $fammarine_id the ID
 	* @param String $ident the marine ident
-	* @param String $departure_airport_icao the departure airport
-	* @param String $arrival_airport_icao the arrival airport
-	* @param String $latitude latitude of flight
-	* @param String $longitude latitude of flight
-	* @param String $waypoints waypoints of flight
-	* @param String $heading heading of flight
-	* @param String $groundspeed speed of flight
-	* @param String $date date of flight
-	* @param String $departure_airport_time departure time of flight
-	* @param String $arrival_airport_time arrival time of flight
-	* @param String $squawk squawk code of flight
-	* @param String $route_stop route stop of flight
-	* @param String $highlight highlight or not
-	* @param String $ModeS ModesS code of flight
-	* @param String $registration registration code of flight
-	* @param String $pilot_id pilot id of flight (for virtual airlines)
-	* @param String $pilot_name pilot name of flight (for virtual airlines)
-	* @param String $verticalrate vertival rate of flight
-	* @return String success or false
 	*/
 	public function addMarineData($fammarine_id = '', $ident = '', $latitude = '', $longitude = '', $heading = '', $groundspeed = '', $date = '', $mmsi = '',$type = '',$typeid = '',$imo = '',$callsign = '',$arrival_code = '',$arrival_date = '',$status = '',$format_source = '', $source_name = '')
 	{
@@ -1444,7 +1425,7 @@ 
 	/**
 	* Parses the direction degrees to working
 	*
-	* @param Float $direction the direction in degrees
+	* @param integer $direction the direction in degrees
 	* @return Array the direction information
 	*
 	*/

require/class.MarineLive.php

Doc Comments +1 added lines, -5 removed lines

@@ -14,7 +14,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, $globalDBdriver;
@@ -762,10 +762,6 @@ 
 	*
 	* @param String $fammarine_id the ID from flightaware
 	* @param String $ident the flight ident
-	* @param String $aircraft_icao the aircraft type
-	* @param String $departure_airport_icao the departure airport
-	* @param String $arrival_airport_icao the arrival airport
-	* @return String success or false
 	*
 	*/
 	public function addLiveMarineData($fammarine_id = '', $ident = '', $latitude = '', $longitude = '', $heading = '', $groundspeed = '', $date = '', $putinarchive = false, $mmsi = '',$type = '',$typeid = '',$imo = '', $callsign = '',$arrival_code = '',$arrival_date = '',$status = '',$noarchive = false,$format_source = '', $source_name = '', $over_country = '')

require/class.SpotterImport.php

Doc Comments +4 added lines

@@ -46,6 +46,10 @@
 
     }
 
+    /**
+     * @param string $id
+     * @param string $ident
+     */
     public function get_Schedule($id,$ident) {
 	global $globalDebug, $globalFork, $globalSchedulesFetch;
 	// Get schedule here, so it's done only one time