Fix doc

ebocher · Oct 30, 2024 · 0b946dc · 0b946dc
1 parent fe0fc55
commit 0b946dc
Show file tree

Hide file tree

Showing 37 changed files with 212 additions and 223 deletions.
diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/factory/H2GISDBFactory.java b/h2gis-functions/src/main/java/org/h2gis/functions/factory/H2GISDBFactory.java
@@ -83,8 +83,8 @@ public static Connection createSpatialDataBase(String dbName)throws SQLException
 
     /**
      * Return the path of the file database
-     * @param dbName
-     * @return 
+     * @param dbName database path
+     * @return TODO : invalid path to be moved in test
      */
     private static String getDataBasePath(String dbName) {
         if(dbName.startsWith("file://")) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/dbf/internal/DBFDriver.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/dbf/internal/DBFDriver.java
@@ -149,7 +149,7 @@ public Value getField(long rowId, int columnId) throws IOException {
 
     /**
      * Get the file reader
-     * @return 
+     * @return {@link DbaseFileReader}
      */
     public DbaseFileReader getDbaseFileReader() {
         return dbaseFileReader;

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/shp/internal/SHPDriver.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/shp/internal/SHPDriver.java
@@ -280,7 +280,7 @@ public void setSRID(int srid) {
 
     /**
      * Get the SRID code
-     * @return 
+     * @return get the SRID
      */
     public int getSrid() {
         return srid;

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/utility/PRJUtil.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/utility/PRJUtil.java
@@ -171,10 +171,9 @@ public static void writePRJ(Connection connection, int srid, File fileName) thro
      * This method checks if a SRID value is valid according a list of SRID's
      * avalaible on spatial_ref table of the datababase.
      * 
-     * @param srid
-     * @param connection
-     * @return 
-     * @throws java.sql.SQLException 
+     * @param srid code
+     * @param connection database
+     * @return true if the srid exists
      */
     public static boolean isSRIDValid(int srid, Connection connection) throws SQLException {
         PreparedStatement ps = null;

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_OffSetCurve.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_OffSetCurve.java
@@ -50,7 +50,7 @@ public String getJavaStaticMethod() {
      * @param geometry the geometry
      * @param offset the distance
      * @param parameters the buffer parameters
-     * @return 
+     * @return {@link Geometry}
      */
     public static Geometry offsetCurve(Geometry geometry, double offset, String parameters) {
         if(geometry == null){
@@ -88,7 +88,7 @@ public static Geometry offsetCurve(Geometry geometry, double offset, String para
      * without buffer parameters
      * @param geometry the geometry
      * @param offset the distance
-     * @return 
+     * @return {@link Geometry}
      */
     public static Geometry offsetCurve(Geometry geometry, double offset) {
         return OffsetCurve.getCurve(geometry, offset);

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_RingSideBuffer.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_RingSideBuffer.java
@@ -56,11 +56,10 @@ public String getJavaStaticMethod() {
 
     /**
      * Compute a ring buffer on one side of the geometry
-     * @param geom
-     * @param bufferSize
-     * @param numBuffer
-     * @return 
-     * @throws java.sql.SQLException 
+     * @param geom input geometry
+     * @param bufferSize buffer distance
+     * @param numBuffer number of rings
+     * @return Geometry
      */
     public static Geometry ringSideBuffer(Geometry geom, double bufferSize, int numBuffer) throws SQLException {
         return ringSideBuffer(geom, bufferSize, numBuffer, "endcap=flat");
@@ -82,13 +81,12 @@ public static Geometry ringSideBuffer(Geometry geom, double bufferDistance,
 
     /**
      * Compute a ring buffer on one side of the geometry
-     * @param geom
-     * @param bufferDistance
-     * @param numBuffer
-     * @param parameters
-     * @param doDifference
-     * @throws SQLException 
-     * @return 
+     * @param geom input geometry
+     * @param bufferDistance buffer distance
+     * @param numBuffer number of rings
+     * @param parameters buffer parameters
+     * @param doDifference true to apply a return the buffer difference
+     * @return Geometry
      */
     public static Geometry ringSideBuffer(Geometry geom, double bufferDistance,
             int numBuffer, String parameters, boolean doDifference) throws SQLException {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_SideBuffer.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/buffer/ST_SideBuffer.java
@@ -51,9 +51,9 @@ public String getJavaStaticMethod() {
 
     /**
      * Compute a single side buffer with default parameters
-     * @param geometry
-     * @param distance
-     * @return 
+     * @param geometry input geometry
+     * @param distance buffer distance
+     * @return Geometry
      */
     public static Geometry singleSideBuffer(Geometry geometry, double distance){
         if(geometry==null){
@@ -66,10 +66,10 @@ public static Geometry singleSideBuffer(Geometry geometry, double distance){
      * Compute a single side buffer with join and mitre parameters
      * Note :
      * The End Cap Style for single-sided buffers is always ignored, and forced to the equivalent of flat.   
-     * @param geometry
-     * @param distance
-     * @param parameters
-     * @return 
+     * @param geometry input geometry
+     * @param distance buffer distance
+     * @param parameters buffer parameters
+     * @return Geometry
      */
     public static Geometry singleSideBuffer(Geometry geometry, double distance, String parameters){
         if(geometry == null){
@@ -103,10 +103,10 @@ public static Geometry singleSideBuffer(Geometry geometry, double distance, Stri
 
     /**
      * Compute the buffer
-     * @param geometry
-     * @param distance
-     * @param bufferParameters
-     * @return 
+     * @param geometry input geometry
+     * @param distance buffer distance
+     * @param bufferParameters buffer parameters
+     * @return Geometry
      */
     private static Geometry computeSingleSideBuffer(Geometry geometry, double distance, BufferParameters bufferParameters){
         bufferParameters.setSingleSided(true);

diff --git a/...ctions/src/main/java/org/h2gis/functions/spatial/convert/GeometryCoordinateDimension.java b/...ctions/src/main/java/org/h2gis/functions/spatial/convert/GeometryCoordinateDimension.java
@@ -37,7 +37,7 @@ public class GeometryCoordinateDimension {
      * @param geom the input geometry
      * @param dimension supported dimension is 2, 3
      * if the dimension is set to 3 the z measure are set to 0
-     * @return 
+     * @return Geometry
      */
      public static Geometry force(Geometry geom, int dimension) {
          Geometry g = geom;
@@ -86,9 +86,9 @@ public static MultiPoint convert(MultiPoint mp, int dimension) {
      /**
       * Force the dimension of the GeometryCollection and update correctly the coordinate 
       * dimension
-      * @param gc
-      * @param dimension
-      * @return 
+      * @param gc {@link GeometryCollection}
+      * @param dimension dimension to extract
+      * @return Geometry
       */
     public static GeometryCollection convert(GeometryCollection gc, int dimension) {
         int nb = gc.getNumGeometries();
@@ -102,9 +102,9 @@ public static GeometryCollection convert(GeometryCollection gc, int dimension) {
     /**
      * Force the dimension of the MultiPolygon and update correctly the coordinate 
      * dimension
-     * @param multiPolygon
-     * @param dimension
-     * @return 
+     * @param multiPolygon {@link MultiPolygon}
+     * @param dimension dimension to extract
+     * @return Geometry
      */
     public static MultiPolygon convert(MultiPolygon multiPolygon,int dimension) {
         int nb = multiPolygon.getNumGeometries();
@@ -118,9 +118,9 @@ public static MultiPolygon convert(MultiPolygon multiPolygon,int dimension) {
      /**
      * Force the dimension of the MultiLineString and update correctly the coordinate 
      * dimension
-     * @param multiLineString
-     * @param dimension
-     * @return 
+     * @param multiLineString {@link MultiLineString}
+     * @param dimension dimension to extract
+     * @return Geometry
      */
     public static MultiLineString convert(MultiLineString multiLineString, int dimension) {
         int nb = multiLineString.getNumGeometries();
@@ -134,9 +134,9 @@ public static MultiLineString convert(MultiLineString multiLineString, int dimen
     /**
      * Force the dimension of the Polygon and update correctly the coordinate 
      * dimension
-     * @param polygon
-     * @param dimension
-     * @return 
+     * @param polygon {@link Polygon}
+     * @param dimension dimension to extract
+     * @return Geometry
      */
     public static Polygon convert(Polygon polygon, int dimension) {
         LinearRing shell = gf.createLinearRing(convertSequence(polygon.getExteriorRing().getCoordinateSequence(),dimension));
@@ -153,9 +153,9 @@ public static Polygon convert(Polygon polygon, int dimension) {
     /**
      * Force the dimension of the LineString and update correctly the coordinate 
      * dimension
-     * @param lineString
-     * @param dimension
-     * @return 
+     * @param lineString {@link LineString}
+     * @param dimension dimension to extract
+     * @return Geometry
      */
     public static LineString convert(LineString lineString,int dimension) {
         return gf.createLineString(convertSequence(lineString.getCoordinateSequence(),dimension));
@@ -164,9 +164,9 @@ public static LineString convert(LineString lineString,int dimension) {
     /**
      * Force the dimension of the LinearRing and update correctly the coordinate 
      * dimension
-     * @param linearRing
-     * @param dimension
-     * @return 
+     * @param linearRing {@link LinearRing}
+     * @param dimension dimension to extract
+     * @return LinearRing
      */
     public static LinearRing convert(LinearRing linearRing,int dimension) {
         return gf.createLinearRing(convertSequence(linearRing.getCoordinateSequence(),dimension));

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/ST_AsGML.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/ST_AsGML.java
@@ -42,8 +42,8 @@ public String getJavaStaticMethod() {
 
     /**
      * Write the GML
-     * @param geom
-     * @return 
+     * @param geom input geometry
+     * @return GML representation
      */
     public static String toGML(Geometry geom) {
         if (geom == null) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/ST_GoogleMapLink.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/ST_GoogleMapLink.java
@@ -47,8 +47,8 @@ public String getJavaStaticMethod() {
     /**
      * Generate a Google Map link URL based on the center of the bounding box of the input geometry
      * 
-     * @param geom
-     * @return 
+     * @param geom input geometry
+     * @return google url location
      */
     public static String generateGMLink(Geometry geom) {
         return generateGMLink(geom, "m", 19);
@@ -58,9 +58,9 @@ public static String generateGMLink(Geometry geom) {
      * Generate a Google Map link URL based on the center of the bounding box of the input geometry
      * and set the layer type
      * 
-     * @param geom
-     * @param layerType
-     * @return 
+     * @param geom input geometry
+     * @param layerType layer type
+     * @return google map url location
      */
     public static String generateGMLink(Geometry geom, String layerType) {
         return generateGMLink(geom, layerType, 19);
@@ -70,10 +70,10 @@ public static String generateGMLink(Geometry geom, String layerType) {
      * Generate a Google Map link URL based on the center of the bounding box of the input geometry.
      * Set the layer type and the zoom level.
      * 
-     * @param geom
-     * @param layerType
-     * @param zoom
-     * @return 
+     * @param geom input geometry
+     * @param layerType layer type
+     * @param zoom zoom level
+     * @return google map url location
      */
     public static String generateGMLink(Geometry geom, String layerType, int zoom) {
         if (geom == null) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/UpdateGeometryZ.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/convert/UpdateGeometryZ.java
@@ -37,7 +37,7 @@ public class UpdateGeometryZ {
      * dimension and change the z value
      * @param geom the input geometry
      * @param z the value to update
-     * @return 
+     * @return Geometry
      */
      public static Geometry force(Geometry geom, double z) {
         Geometry g = geom;
@@ -63,9 +63,9 @@ public static Geometry force(Geometry geom, double z) {
      /**
       * Force the dimension of the GeometryCollection and update correctly the coordinate 
       * dimension
-      * @param gc
-      * @param z
-      * @return 
+      * @param gc {@link GeometryCollection}
+      * @param z Z value
+      * @return Geometry
       */
     public static GeometryCollection convert(GeometryCollection gc, double z) {
         int nb = gc.getNumGeometries();
@@ -79,9 +79,9 @@ public static GeometryCollection convert(GeometryCollection gc, double z) {
     /**
      * Force the dimension of the MultiPolygon and update correctly the coordinate 
      * dimension
-     * @param multiPolygon
-     * @param z
-     * @return 
+     * @param multiPolygon MultiPolygon
+     * @param z Z value
+     * @return MultiPolygon
      */
     public static MultiPolygon convert(MultiPolygon multiPolygon,double z) {
         int nb = multiPolygon.getNumGeometries();
@@ -95,9 +95,9 @@ public static MultiPolygon convert(MultiPolygon multiPolygon,double z) {
      /**
      * Force the dimension of the MultiLineString and update correctly the coordinate 
      * dimension
-     * @param multiLineString
-     * @param z
-     * @return 
+     * @param multiLineString {@link MultiLineString}
+     * @param z value
+     * @return MultiLineString
      */
     public static MultiLineString convert(MultiLineString multiLineString, double z) {
         int nb = multiLineString.getNumGeometries();
@@ -111,9 +111,9 @@ public static MultiLineString convert(MultiLineString multiLineString, double z)
     /**
      * Force the dimension of the Polygon and update correctly the coordinate 
      * dimension
-     * @param polygon
-     * @param z
-     * @return 
+     * @param polygon {@link Polygon}
+     * @param z value
+     * @return Polygon
      */
     public static Polygon convert(Polygon polygon, double z) {
         LinearRing shell = gf.createLinearRing(convertSequence(polygon.getExteriorRing().getCoordinates(),z));
@@ -130,9 +130,9 @@ public static Polygon convert(Polygon polygon, double z) {
     /**
      * Force the dimension of the LineString and update correctly the coordinate 
      * dimension
-     * @param lineString
-     * @param z
-     * @return 
+     * @param lineString {@link LineString}
+     * @param z value
+     * @return LineString
      */
     public static LineString convert(LineString lineString,double z) {
         return gf.createLineString(convertSequence(lineString.getCoordinates(),z));
@@ -141,9 +141,9 @@ public static LineString convert(LineString lineString,double z) {
     /**
      * Force the dimension of the LinearRing and update correctly the coordinate 
      * dimension
-     * @param linearRing
-     * @param z
-     * @return 
+     * @param linearRing {@link LinearRing}
+     * @param z value
+     * @return LinearRing
      */
     public static LinearRing convert(LinearRing linearRing,double z) {
         return gf.createLinearRing(convertSequence(linearRing.getCoordinates(),z));

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/spatial/create/ST_MinimumRectangle.java b/h2gis-functions/src/main/java/org/h2gis/functions/spatial/create/ST_MinimumRectangle.java
@@ -46,7 +46,7 @@ public String getJavaStaticMethod() {
     /**
      * Gets the minimum rectangular {@link Polygon} which encloses the input geometry.
      * @param geometry Input geometry
-     * @return 
+     * @return Geometry
      */
     public static Geometry computeMinimumRectangle(Geometry geometry){
         if(geometry == null){