Fix doc

orbisgis · Oct 30, 2024 · 480d995 · 480d995
1 parent d3461f9
commit 480d995
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 31 deletions.
diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/geojson/ST_AsGeoJSON.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/geojson/ST_AsGeoJSON.java
@@ -81,7 +81,7 @@ public static String toGeojson(Geometry geom, int maxdecimaldigits) {
      *
      * @param geom input geometry
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonGeometry(Geometry geom, int maxdecimaldigits, StringBuilder sb) {
         if (geom instanceof Point) {
@@ -123,9 +123,9 @@ public static void toGeojsonGeometry(Geometry geom, int maxdecimaldigits, String
      *
      * { "type": "Point", "coordinates": [100.0, 0.0] }
      *
-     * @param point
+     * @param point input point
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonPoint(Point point, int maxdecimaldigits, StringBuilder sb) {
         Coordinate coord = point.getCoordinate();
@@ -147,9 +147,9 @@ public static void toGeojsonPoint(Point point, int maxdecimaldigits, StringBuild
      *
      * { "type": "MultiPoint", "coordinates": [ [100.0, 0.0], [101.0, 1.0] ] }
      *
-     * @param multiPoint
+     * @param multiPoint input {@link MultiPoint}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonMultiPoint(MultiPoint multiPoint,int maxdecimaldigits,  StringBuilder sb) {
         sb.append("{\"type\":\"MultiPoint\",\"coordinates\":");
@@ -164,9 +164,9 @@ public static void toGeojsonMultiPoint(MultiPoint multiPoint,int maxdecimaldigit
      *
      * { "type": "LineString", "coordinates": [ [100.0, 0.0], [101.0, 1.0] ] }
      *
-     * @param lineString
+     * @param lineString input {@link MultiLineString}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonLineString(LineString lineString, int maxdecimaldigits, StringBuilder sb) {
         sb.append("{\"type\":\"LineString\",\"coordinates\":");
@@ -183,9 +183,9 @@ public static void toGeojsonLineString(LineString lineString, int maxdecimaldigi
      * { "type": "MultiLineString", "coordinates": [ [ [100.0, 0.0], [101.0,
      * 1.0] ], [ [102.0, 2.0], [103.0, 3.0] ] ] }
      *
-     * @param multiLineString
+     * @param multiLineString input {@link MultiLineString}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonMultiLineString(MultiLineString multiLineString,int maxdecimaldigits,  StringBuilder sb) {
         sb.append("{\"type\":\"MultiLineString\",\"coordinates\":[");
@@ -218,9 +218,9 @@ public static void toGeojsonMultiLineString(MultiLineString multiLineString,int
      * [100.8, 0.8], [100.2, 0.8], [100.2, 0.2] ] ] }
      *
      *
-     * @param polygon
+     * @param polygon input {@link Polygon}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonPolygon(Polygon polygon,int maxdecimaldigits,  StringBuilder sb) {
         sb.append("{\"type\":\"Polygon\",\"coordinates\":[");
@@ -244,9 +244,9 @@ public static void toGeojsonPolygon(Polygon polygon,int maxdecimaldigits,  Strin
      * [101.0, 1.0], [100.0, 1.0], [100.0, 0.0]], [[100.2, 0.2], [100.8, 0.2],
      * [100.8, 0.8], [100.2, 0.8], [100.2, 0.2]]] ] }
      *
-     * @param multiPolygon
+     * @param multiPolygon input {@link MultiPolygon}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonMultiPolygon(MultiPolygon multiPolygon, int maxdecimaldigits, StringBuilder sb) {
         sb.append("{\"type\":\"MultiPolygon\",\"coordinates\":[");
@@ -284,9 +284,9 @@ public static void toGeojsonMultiPolygon(MultiPolygon multiPolygon, int maxdecim
      * "coordinates": [100.0, 0.0] }, { "type": "LineString", "coordinates": [
      * [101.0, 0.0], [102.0, 1.0] ] } ] }
      *
-     * @param geometryCollection
+     * @param geometryCollection input {@link GeometryCollection}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonGeometryCollection(GeometryCollection geometryCollection,int maxdecimaldigits,  StringBuilder sb) {
         sb.append("{\"type\":\"GeometryCollection\",\"geometries\":[");
@@ -315,9 +315,9 @@ public static void toGeojsonGeometryCollection(GeometryCollection geometryCollec
      *
      * [[X1,Y1],[X2,Y2]]
      *
-     * @param coords
+     * @param coords input coordinates array
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonCoordinates(Coordinate[] coords, int maxdecimaldigits, StringBuilder sb) {
         sb.append("[");
@@ -339,9 +339,9 @@ public static void toGeojsonCoordinates(Coordinate[] coords, int maxdecimaldigit
      *
      * [X,Y] or [X,Y,Z]
      *
-     * @param coord
+     * @param coord input {@link Coordinate}
      * @param maxdecimaldigits argument may be used to reduce the maximum number of decimal places
-     * @param sb
+     * @param sb buffer to store the geojson
      */
     public static void toGeojsonCoordinate(Coordinate coord, int maxdecimaldigits, StringBuilder sb) {
         sb.append("[");

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/AltitudeMode.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/AltitudeMode.java
@@ -67,8 +67,8 @@ private AltitudeMode() {
      * Generate a string value corresponding to the altitude mode.
      * 
      *
-     * @param altitudeMode
-     * @param sb
+     * @param altitudeMode {@link AltitudeMode}
+     * @param sb buffer to store the kml
      */
     public static void append(int altitudeMode, StringBuilder sb) {
         switch (altitudeMode) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/KMLGeometry.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/KMLGeometry.java
@@ -47,10 +47,10 @@ public static void toKMLGeometry(Geometry geom, StringBuilder sb) throws SQLExce
     /**
      * Convert JTS geometry to a kml geometry representation.
      *
-     * @param geometry
-     * @param extrude
-     * @param altitudeModeEnum
-     * @param sb
+     * @param geometry input geometry
+     * @param extrude extrude mode
+     * @param altitudeModeEnum altitude mode
+     * @param sb buffer to store the KML
      */
     public static void toKMLGeometry(Geometry geometry, ExtrudeMode extrude, int altitudeModeEnum, StringBuilder sb) throws SQLException {
         if (geometry instanceof Point) {
@@ -281,7 +281,7 @@ public static void toKMLMultiGeometry(GeometryCollection gc, ExtrudeMode extrude
      * {@code
      * <coordinates>...</coordinates> <!-- lon,lat[,alt] tuples -->
      * }
-     * @param coords
+     * @param coords coordinates array
      */
     public static void appendKMLCoordinates(Coordinate[] coords, StringBuilder sb) {
         sb.append("<coordinates>");
@@ -305,8 +305,8 @@ public static void appendKMLCoordinates(Coordinate[] coords, StringBuilder sb) {
      *
      * <extrude>0</extrude>
      *
-     * @param extrude
-     * @param sb
+     * @param extrude {@link ExtrudeMode}
+     * @param sb buffer to store the KML
      */
     private static void appendExtrude(ExtrudeMode extrude, StringBuilder sb) {
         if (extrude.equals(ExtrudeMode.TRUE)) {
@@ -323,8 +323,8 @@ private static void appendExtrude(ExtrudeMode extrude, StringBuilder sb) {
      *
      * <altitudeMode>clampToGround</altitudeMode>
      *
-     * @param altitudeModeEnum
-     * @param sb
+     * @param altitudeModeEnum {@link AltitudeMode}
+     * @param sb buffer to store the KML
      */
     private static void appendAltitudeMode(int altitudeModeEnum, StringBuilder sb) {
         AltitudeMode.append(altitudeModeEnum, sb);

diff --git a/h2gis-utilities/src/main/java/org/h2gis/utilities/TableLocation.java b/h2gis-utilities/src/main/java/org/h2gis/utilities/TableLocation.java
@@ -429,7 +429,7 @@ public void setDefaultSchema(String defaultSchema) {
     /**
      * Return the dbtype used by tablelocation.
      * Default is H2
-     * @return
+     * @return the {@link DBTypes}
      */
     public DBTypes getDbTypes() {
         return dbTypes;