Ysurac / FlightAirMap

require/class.APRS.php

Doc Comments +7 added lines

@@ -89,6 +89,10 @@ 
 	'y' => 'Yagi At QTH');
 	
 
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
 	    (($n & 0x7fffffff) >> $s) | 
@@ -483,6 +487,9 @@ 
 	socket_close($this->socket);
     }
     
+    /**
+     * @param string $data
+     */
     public function send($data) {
 	global $globalDebug;
 	if ($this->connected === false) $this->connect();

require/class.Elevation.php

Doc Comments +11 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 		$this->openedFiles = [];
 	}
 
+	/**
+	 * @param double $row
+	 * @param double $column
+	 */
 	private function getElevationAtPosition($fileName, $row, $column) {
 		if (!array_key_exists($fileName, $this->openedFiles)) {
 			if (!file_exists($this->htgFilesDestination . DIRECTORY_SEPARATOR . $fileName)) {
@@ -85,7 +89,7 @@ 
 	 * @param float $lon
 	 * @param null  $fName
 	 *
-	 * @return mixed
+	 * @return double
 	 * @throws \Exception
 	 */
 	public function getElevation($lat, $lon, &$fName = null) {
@@ -142,6 +146,9 @@ 
 		return $zN;
 	}
 
+	/**
+	 * @param integer $numPrefix
+	 */
 	private function getDeg($deg, $numPrefix) {
 		$deg = abs($deg);
 		$d   = floor($deg);     // round degrees
@@ -156,6 +163,9 @@ 
 		return $d;
 	}
 
+	/**
+	 * @param double $deg
+	 */
 	private function getSec($deg) {
 		$deg = abs($deg);
 		$sec = round($deg * 3600, 4);

require/class.Common.php

Doc Comments +15 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');
@@ -106,6 +110,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
@@ -211,7 +218,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);
@@ -234,6 +241,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -245,6 +255,9 @@ 
 		return $deg+(($min*60)/3600);
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -382,7 +395,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.GeoidHeight.php

Doc Comments +4 added lines

@@ -91,6 +91,10 @@
 		$this->rlatres = (($this->height - 1) / 180.0);
 	}
 
+	/**
+	 * @param integer $ix
+	 * @param integer $iy
+	 */
 	private function _rawval($ix,$iy) {
 		if (($iy < 0)) {
 			$iy = -$iy;

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 45;
 	
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null,$user = null,$pass = null) {
 	    global $globalDBdriver, $globalNoDB;
 	    if (isset($globalNoDB) && $globalNoDB === TRUE) {
@@ -141,6 +144,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -190,6 +196,11 @@ 
 	/*
 	* Check if index exist
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $index
+	 */
 	public function indexExists($table,$index)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -232,6 +243,10 @@ 
 		return $columns;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $column
+	 */
 	public function getColumnType($table,$column) {
 		$select = $this->db->query('SELECT '.$column.' FROM '.$table);
 		$tomet = $select->getColumnMeta(0);
@@ -242,6 +257,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)
 	{
 		global $globalDBdriver, $globalDBname;