Docs improvements (#557)

vtm/src/org/oscim/layers/tile/buildings/BuildingLayer.java

@@ -46,6 +46,9 @@ public class BuildingLayer extends Layer implements TileLoaderThemeHook, ZoomLim
 
     public final static int MIN_ZOOM = 17;
 
+    /**
+     * Use Fast Approximate Anti-Aliasing (FXAA) and Screen Space Ambient Occlusion (SSAO).
+     */
     public static boolean POST_AA = false;
 
     /**
@@ -79,6 +82,13 @@ public class BuildingLayer extends Layer implements TileLoaderThemeHook, ZoomLim
         this(map, tileLayer, MIN_ZOOM, map.viewport().getMaxZoomLevel(), mesh);
     }
 
+    /**
+     * @param map       The map data to add
+     * @param tileLayer The vector tile layer which contains the tiles and the map elements
+     * @param zoomMin   The minimum zoom at which the layer appears
+     * @param zoomMax   The maximum zoom at which the layer appears
+     * @param mesh      Declare if using mesh or polygon renderer
+     */
     public BuildingLayer(Map map, VectorTileLayer tileLayer, int zoomMin, int zoomMax, boolean mesh) {
 
         super(map);

vtm/src/org/oscim/layers/tile/buildings/S3DBLayer.java

@@ -52,6 +52,12 @@ public class S3DBLayer extends BuildingLayer {
         this(map, tileLayer, MIN_ZOOM, map.viewport().getMaxZoomLevel());
     }
 
+    /**
+     * @param map       The map data to add
+     * @param tileLayer The vector tile layer which contains the tiles and map elements
+     * @param zoomMin   The minimum zoom at which the layer appears
+     * @param zoomMax   The maximum zoom at which the layer appears
+     */
     public S3DBLayer(Map map, VectorTileLayer tileLayer, int zoomMin, int zoomMax) {
         super(map, tileLayer, zoomMin, zoomMax, true);
     }
@@ -60,6 +66,10 @@ public class S3DBLayer extends BuildingLayer {
         return mColored;
     }
 
+    /**
+     * @param colored true: use colour written in '*:colour' tag,
+     *                false: use top colour of extrusion style
+     */
     public void setColored(boolean colored) {
         mColored = colored;
     }
@@ -69,7 +79,8 @@ public class S3DBLayer extends BuildingLayer {
     }
 
     /**
-     * @param transparent if true it adopts transparency of extrusion styles
+     * @param transparent if true coloured buildings blend transparency of extrusion style
+     *                    (only in combination with isColored = true)
      */
     public void setTransparent(boolean transparent) {
         mTransparent = transparent;

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

@@ -12,8 +12,8 @@ public class OffscreenRenderer extends LayerRenderer {
     final static Logger log = LoggerFactory.getLogger(OffscreenRenderer.class);
 
     public enum Mode {
-        FXAA,
+        FXAA, // Fast Approximate Anti-Aliasing
-        SSAO,
+        SSAO, // Screen Space Ambient Occlusion
         SSAO_FXAA,
         BYPASS
     }

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

@@ -116,20 +116,20 @@ public abstract class ScanBox {
         xmin = (int) min;
         xmax = (int) max;
 
-        // top-left -> top-right
+        // 🡐 top-right -> top-left
         ab.set(box[0], box[1], box[2], box[3]);
-        // top-right ->  bottom-right
+        // 🡓 top-left ->  bottom-left
         bc.set(box[2], box[3], box[4], box[5]);
-        // bottom-right -> bottom-left
+        // 🡕 bottom-left -> top-right
         ca.set(box[4], box[5], box[0], box[1]);
 
         scanTriangle();
 
-        // top-left -> bottom-right
+        // 🡗 top-right -> bottom-left
         ab.set(box[0], box[1], box[4], box[5]);
-        // bottom-right -> bottom-left
+        // 🡒 bottom-left -> bottom-right
         bc.set(box[4], box[5], box[6], box[7]);
-        // bottom-left -> top-left
+        // 🡑 bottom-right -> top-right
         ca.set(box[6], box[7], box[0], box[1]);
 
         scanTriangle();