Ysurac / FlightAirMap

require/class.AIS.php

Doc Comments +25 added lines

@@ -68,6 +68,10 @@ 
        't', 'u', 'v', 'w' // 119
     ); // char 64
     */
+
+	/**
+	 * @param integer $ascii
+	 */
 	private function asciidec_2_8bit($ascii) {
 		//only process in the following range: 48-87, 96-119
 		if ($ascii < 48) { }
@@ -93,6 +97,10 @@ 
 		return(substr($bin, -6)); 
 	}
 
+	/**
+	 * @param integer $_start
+	 * @param integer $_size
+	 */
 	private function binchar($_str, $_start, $_size) {
 		//  ' ' --- '?', // 0x20 - 0x3F
 		//  '@' --- '_', // 0x40 - 0x5F
@@ -118,6 +126,10 @@ 
 	}
 
 	// function for decoding the AIS Message ITU Payload
+
+	/**
+	 * @param string $_aisdata
+	 */
 	private function decode_ais($_aisdata) {
 		$ro = new stdClass(); // return object
 		$ro->cls = 0; // AIS class undefined, also indicate unparsed msg
@@ -350,6 +362,12 @@ 
 		elseif ($code == 99) return 'Other Type, no additional information';
 	}
 
+	/**
+	 * @param string $_itu
+	 * @param integer $_len
+	 * @param integer $_filler
+	 * @param string $aux
+	 */
 	public function process_ais_itu($_itu, $_len, $_filler, $aux /*, $ais_ch*/) {
 		global $port; // tcpip port...
 		static $debug_counter = 0;
@@ -369,6 +387,10 @@ 
 
 	// char* - AIS \r terminated string
 	// TCP based streams which send messages in full can use this instead of calling process_ais_buf
+
+	/**
+	 * @param string $rawdata
+	 */
 	public function process_ais_raw($rawdata, $aux = '') { // return int
 		static $num_seq; // 1 to 9
 		static $seq; // 1 to 9
@@ -591,6 +613,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $mmsi
+	 */
 	public function mmsitype($mmsi) {
 		if (strlen($mmsi) == 9) {
 			if (substr($mmsi,0,3) == '974') return 'EPIRB (Emergency Position Indicating Radio Beacon) AIS';