Changeset 9428 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2016-01-13T02:02:36+01:00 (8 years ago)

Author:

Don-vip

Message:

see #12186 - fix some javadoc warnings

Location:

trunk/src/org/openstreetmap/josm/data/projection/proj

Files:

• AbstractProj.java (modified) (4 diffs)
• AlbersEqualArea.java (modified) (1 diff)
• PolarStereographic.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/projection/proj/AbstractProj.java

@@ -53 +53 @@
 
     /**
-     * Ellipsoid excentricity, equals to <code>sqrt({@link #excentricitySquared})</code>.
+     * Ellipsoid excentricity, equals to <code>sqrt({@link #e2 excentricity squared})</code>.
      * Value 0 means that the ellipsoid is spherical.
      *
-     * @see #excentricitySquared
+     * @see #e2
      */
     protected double e;
@@ -65 +65 @@
      * <var>a</var> is the semi major axis length and
      * <var>b</var> is the semi minor axis length.
+     *
+     * @see #e
      */
     protected double e2;
@@ -147 +149 @@
      * Computes function <code>f(s,c,e²) = c/sqrt(1 - s²&times;e²)</code> needed for the true scale
      * latitude (Snyder 14-15), where <var>s</var> and <var>c</var> are the sine and cosine of
-     * the true scale latitude, and <var>e²</var> is the {@linkplain #excentricitySquared
-     * eccentricity squared}.
+     * the true scale latitude, and <var>e²</var> is the {@linkplain #e2 eccentricity squared}.
+     * @param s sine of the true scale latitude
+     * @param c cosine of the true scale latitude
+     * @return <code>c/sqrt(1 - s²&times;e²)</code>
      */
     final double msfn(final double s, final double c) {
@@ -160 +164 @@
     final double tsfn(final double lat, double sinlat) {
         sinlat *= e;
-        /*
-         * NOTE: change sign to get the equivalent of Snyder (7-7).
-         */
+        // NOTE: change sign to get the equivalent of Snyder (7-7).
         return Math.tan(0.5 * (Math.PI/2 - lat)) / Math.pow((1 - sinlat) / (1 + sinlat), 0.5*e);
     }

trunk/src/org/openstreetmap/josm/data/projection/proj/AlbersEqualArea.java

@@ -72 +72 @@
 
     /**
-     * Standards parallel 1 in radians, for {@link #getParameterValues} implementation.
+     * Standards parallel 1 in radians.
      */
     private double phi1;
 
     /**
-     * Standards parallel 2 in radians, for {@link #getParameterValues} implementation.
+     * Standards parallel 2 in radians.
      */
     private double phi2;

trunk/src/org/openstreetmap/josm/data/projection/proj/PolarStereographic.java

@@ -8 +8 @@
 
 /**
- * The polar case of the {@linkplain Stereographic stereographic} projection.
+ * The polar case of the stereographic projection.
  * <p>
  * In the proj.4 library, the code "stere" covers several variants of the
@@ -75 +75 @@
     /**
      * A constant used in the transformations.
-     * This is <strong>not</strong> equal to the {@link #scaleFactor}.
      */
     private double k0;
@@ -115 +114 @@
         southPole = latitudeTrueScale < 0;
 
-        /*
-         * Computes coefficients.
-         */
+        // Computes coefficients.
         double latitudeTrueScaleAbs = Math.abs(latitudeTrueScale);
         if (Math.abs(latitudeTrueScaleAbs - Math.PI/2) >= EPSILON) {
@@ -126 +123 @@
             // True scale at pole (part of (21-33))
             k0 = 2.0 / Math.sqrt(Math.pow(1+e, 1+e)*
-                            Math.pow(1-e, 1-e));
+                                 Math.pow(1-e, 1-e));
         }
     }