Javadoc improvements (#1293)

Author: devemux86

vtm-jts/src/org/oscim/layers/vector/geometries/PolygonDrawable.java

@@ -60,8 +60,8 @@ public PolygonDrawable(List<GeoPoint> points, Style style) {
      *
      * @param points
      * @param holePoints
-     * @param outlineColor
-     * @param outlineAlpha
+     * @param lineWidth
+     * @param lineColor
      * @param fillColor
      * @param fillAlpha
      */
@@ -80,8 +80,8 @@ public PolygonDrawable(GeoPoint[] points, GeoPoint[] holePoints, float lineWidth
      *
      * @param points
      * @param holePoints
-     * @param outlineColor
-     * @param outlineAlpha
+     * @param lineWidth
+     * @param lineColor
      * @param fillColor
      * @param fillAlpha
      */

vtm-jts/src/org/oscim/layers/vector/geometries/RectangleDrawable.java

@@ -40,8 +40,11 @@ public RectangleDrawable(GeoPoint topLeft, GeoPoint bottomRight, Style style) {
      * Creates a Rectangle given the top-left and the bottom-right coordinate of
      * it
      *
-     * @param topLeft
-     * @param bottomRight
+     * @param minLat
+     * @param minLon
+     * @param maxLat
+     * @param maxLon
+     * @param style
      */
     public RectangleDrawable(double minLat, double minLon, double maxLat, double maxLon, Style style) {
         super(style);

vtm/src/org/oscim/core/GeometryBuffer.java

@@ -151,10 +151,10 @@ public GeometryBuffer(GeometryBuffer buffer) {
     }
 
     /**
-     * @param out PointF to set coordinates to.
-     * @param i   the 2D point position.
-     * @return when out is null a temporary PointF is
+     * When out is null a temporary PointF is
      * returned which belongs to GeometryBuffer.
+     * @param i   the 2D point position.
+     * @param out PointF to set coordinates to.
      */
     public void getPoint(int i, PointF out) {
         out.x = points[(i << 1)];

vtm/src/org/oscim/core/MercatorProjection.java

@@ -77,7 +77,7 @@ public static GeoPoint fromPixels(double pixelX, double pixelY, long mapSize) {
     /**
      * @param scale the scale factor for which the size of the world map should be returned.
      * @return the horizontal and vertical size of the map in pixel at the given scale.
-     * @throws IllegalArgumentException if the given scale factor is < 1
+     * @throws IllegalArgumentException if the given scale factor is {@code < 1}
      */
     public static long getMapSizeWithScale(double scale) {
         if (scale < 1) {

vtm/src/org/oscim/layers/marker/MarkerLayer.java

@@ -32,7 +32,7 @@
  * Draws a list of {@link MarkerInterface} as markers to a map. The item with the
  * lowest index is drawn as last and therefore the 'topmost' marker. It also
  * gets checked for onTap first. This class is generic, because you then you get
- * your custom item-class passed back in onTap(). << TODO
+ * your custom item-class passed back in onTap().
  */
 public abstract class MarkerLayer extends Layer {
 

vtm/src/org/oscim/renderer/GLMatrix.java

@@ -109,7 +109,7 @@ public void prj2D(float[] vec2, int offset, int length) {
     /**
      * Project Vectors with Matrix
      *
-     * @param vec2 Vector to project
+     * @param src Vector to project
      */
     public void prj2D(float[] src, int src_offset, float[] dst, int dst_offset, int length) {
         if (src == null || src_offset < 0 || length + src_offset * 2 > src.length)

vtm/src/org/oscim/renderer/LayerRenderer.java

@@ -51,21 +51,11 @@ public boolean setup() {
     /**
      * 1. Called first by MapRenderer: Update the state here, compile
      * vertex-data and set setReady(true).
-     *
-     * @param position current MapPosition
-     * @param changed  true when MapPosition has changed since last frame
-     * @param matrices contains the current view- and projection-matrices
-     *                 and 'mvp' matrix for temporary use.
      */
     public abstract void update(GLViewport viewport);
 
     /**
      * 2. Draw layer: called by MapRenderer when isReady == true.
-     *
-     * @param position current MapPosition
-     * @param matrices contains the current view- and projection-matrices.
-     *                 'matrices.mvp' is for temporary use to build the model-
-     *                 view-projection to set as uniform.
      */
     public abstract void render(GLViewport viewport);
 

vtm/src/org/oscim/renderer/bucket/LineTexBucket.java

@@ -73,7 +73,7 @@
  * 6, 5, 7,
  * <p/>
  * BIG NOTE: renderer assumes to be able to offset vertex array position
- * so that in the first pass 'pos1' offset will be < 0 if no data precedes
+ * so that in the first pass 'pos1' offset will be {@code < 0} if no data precedes
  * - in our case there is always the polygon fill array at start
  * - see addLine hack otherwise.
  */

vtm/src/org/oscim/tiling/source/mapfile/MapFile.java

@@ -1125,7 +1125,7 @@ public MapReadResult readNamedItems(Tile tile) {
     /**
      * Reads data for an area defined by the tile in the upper left and the tile in
      * the lower right corner.
-     * Precondition: upperLeft.tileX <= lowerRight.tileX && upperLeft.tileY <= lowerRight.tileY
+     * Precondition: {@code upperLeft.tileX <= lowerRight.tileX && upperLeft.tileY <= lowerRight.tileY}
      *
      * @param upperLeft  tile that defines the upper left corner of the requested area.
      * @param lowerRight tile that defines the lower right corner of the requested area.
@@ -1148,7 +1148,7 @@ public MapReadResult readMapData(Tile tile) {
     /**
      * Reads data for an area defined by the tile in the upper left and the tile in
      * the lower right corner.
-     * Precondition: upperLeft.tileX <= lowerRight.tileX && upperLeft.tileY <= lowerRight.tileY
+     * Precondition: {@code upperLeft.tileX <= lowerRight.tileX && upperLeft.tileY <= lowerRight.tileY}
      *
      * @param upperLeft  tile that defines the upper left corner of the requested area.
      * @param lowerRight tile that defines the lower right corner of the requested area.

vtm/src/org/oscim/utils/ColorUtil.java

@@ -97,9 +97,9 @@ public static synchronized int modHsv(int color, double hue, double saturation,
      * Assumes r, g, and b are contained in the set [0, 255] and
      * returns h, s, and l in the set [0, 1].
      *
-     * @param Number r The red color value
-     * @param Number g The green color value
-     * @param Number b The blue color value
+     * @param r The red color value
+     * @param g The green color value
+     * @param b The blue color value
      * @return Array The HSL representation
      */
     public static Vec3 rgbToHsl(double r, double g, double b, Vec3 out) {
@@ -140,9 +140,9 @@ public static Vec3 rgbToHsl(double r, double g, double b) {
      * Assumes h, s, and l are contained in the set [0, 1] and
      * returns r, g, and b in the set [0, 255].
      *
-     * @param Number h The hue
-     * @param Number s The saturation
-     * @param Number l The lightness
+     * @param h The hue
+     * @param s The saturation
+     * @param l The lightness
      * @return Array The RGB representation
      */
     public static int hslToRgb(double h, double s, double l, Vec3 out) {
@@ -184,9 +184,9 @@ static double hue2rgb(double p, double q, double t) {
      * Assumes r, g, and b are contained in the set [0, 255] and
      * returns h, s, and v in the set [0, 1].
      *
-     * @param Number r The red color value
-     * @param Number g The green color value
-     * @param Number b The blue color value
+     * @param r The red color value
+     * @param g The green color value
+     * @param b The blue color value
      * @return Array The HSV representation
      */
     public static Vec3 rgbToHsv(double r, double g, double b, Vec3 out) {