Ysurac / FlightAirMap

require/libs/geoPHP/lib/adapters/WKT.class.php

Doc Comments +6 added lines, -1 removed lines

@@ -8,7 +8,6 @@ 
   /**
    * Read WKT string into geometry objects
    *
-   * @param string $WKT A WKT string
    *
    * @return Geometry
    */
@@ -184,11 +183,17 @@ 
     else return $str;
   }
   
+  /**
+   * @param string $char
+   */
   protected function beginsWith($str, $char) {
     if (substr($str,0,strlen($char)) == $char) return TRUE;
     else return FALSE;
   }
 
+  /**
+   * @param string $char
+   */
   protected function endsWith($str, $char) {
     if (substr($str,(0 - strlen($char))) == $char) return TRUE;
     else return FALSE;

require/libs/geoPHP/lib/geometry/Polygon.class.php

Doc Comments +3 added lines

@@ -193,6 +193,9 @@
     }
   }
   
+  /**
+   * @param Point $point
+   */
   public function pointOnVertex($point) {
     foreach($this->getPoints() as $vertex) {
       if ($point->equals($vertex)) {

require/libs/geoPHP/tests/postgis.php

Doc Comments +4 added lines

@@ -41,6 +41,10 @@
   print "Testing Done!";
 }
 
+/**
+ * @param resource $connection
+ * @param string $format
+ */
 function test_postgis($name, $type, $geom, $connection, $format) {
   global $table;
   

require/libs/geoPHP/tests/test.php

Doc Comments +6 added lines

@@ -112,6 +112,9 @@ 
   $geometry->m();
 }
 
+/**
+ * @param string $input
+ */
 function test_adapters($geometry, $format, $input) {
   // Test adapter output and input. Do a round-trip and re-test
   foreach (geoPHP::getAdapterMap() as $adapter_key => $adapter_class) {
@@ -234,6 +237,9 @@ 
   }
 }
 
+/**
+ * @param string $value
+ */
 function test_detection($value, $format, $file) {
   $detected = geoPHP::detectFormat($value);
   if ($detected != $format) {

require/libs/geoPHP/tests/tests/methodsTest.php

Doc Comments +4 added lines

@@ -58,6 +58,10 @@
     }
   }
 
+  /**
+   * @param string $method_name
+   * @param string|null $argument
+   */
   function _methods_tester($geometry, $method_name, $argument) {
 
     if (!method_exists($geometry, $method_name)) {

require/libs/uagent/uagent.php

Doc Comments +3 added lines

@@ -122,6 +122,9 @@
         return self::array_random( empty( $lang ) ? self::$languages : $lang );
     }
 
+    /**
+     * @param string $os
+     */
     private static function get_processor( $os )
     {
         return self::array_random( self::$processors[$os] );

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