updating javadoc comments

GIScience · Aug 13, 2018 · 121371b · 121371b
1 parent 5c0f4c0
commit 121371b
Show file tree

Hide file tree

Showing 9 changed files with 236 additions and 210 deletions.
diff --git a/...org/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/AreaController.java b/...org/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/AreaController.java
diff --git a/...rg/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/CountController.java b/...rg/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/CountController.java
diff --git a/...g/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/LengthController.java b/...g/heigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/LengthController.java
diff --git a/...eigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/PerimeterController.java b/...eigit/bigspatialdata/ohsome/ohsomeApi/controller/dataAggregation/PerimeterController.java
diff --git a/...a/org/heigit/bigspatialdata/ohsome/ohsomeApi/output/dataAggregationResponse/Response.java b/...a/org/heigit/bigspatialdata/ohsome/ohsomeApi/output/dataAggregationResponse/Response.java
@@ -1,9 +1,28 @@
 package org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse;
 
+/**
+ * Interface for most Response classes.
+ * 
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.DefaultAggregationResponse
+ *      DefaultAggregationResponse}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.elements.ShareResponse
+ *      ShareResponse}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.GroupByResponse
+ *      GroupByResponse}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.RatioGroupByBoundaryResponse
+ *      RatioGroupByBoundaryResponse}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.ShareGroupByBoundaryResponse
+ *      ShareGroupByBoundaryResponse}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.RatioResponse
+ *      RatioResponse}
+ * 
+ */
 public interface Response {
-  
+
   public Attribution getAttribution();
+
   public String getApiVersion();
+
   public Metadata getMetadata();
-  
+
 }
diff --git a/...ava/org/heigit/bigspatialdata/ohsome/ohsomeApi/output/dataAggregationResponse/Result.java b/...ava/org/heigit/bigspatialdata/ohsome/ohsomeApi/output/dataAggregationResponse/Result.java
@@ -1,6 +1,13 @@
 package org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse;
 
-/** Interface used for the Result objects. */
+/**
+ * Interface for two Result objects.
+ * 
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.elements.ElementsResult
+ *      ElementsResult}
+ * @see {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.RatioResult
+ *      RatioResult}
+ */
 public interface Result {
 
   public double getValue();

diff --git a/...data/ohsome/ohsomeApi/output/dataAggregationResponse/groupByResponse/GroupByResponse.java b/...data/ohsome/ohsomeApi/output/dataAggregationResponse/groupByResponse/GroupByResponse.java
@@ -14,9 +14,9 @@
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.Metadata
  * Metadata}, the requested
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.GroupByResult
- * GroupByResult} and an identifier of the object plus the corresponding
- * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.elements.ElementsResult
- * ElementsResult} objects.
+ * GroupByResult} for a JSON response and an identifier of the object. If the output format is GeoJSON, the response
+ * includes a {@link org.geojson.Feature Feature} array, which holds the respective objects with
+ * their timestamp-value pairs.
  */
 @JsonInclude(Include.NON_NULL)
 public class GroupByResponse implements Response {

diff --git a/...hsomeApi/output/dataAggregationResponse/groupByResponse/RatioGroupByBoundaryResponse.java b/...hsomeApi/output/dataAggregationResponse/groupByResponse/RatioGroupByBoundaryResponse.java
@@ -14,9 +14,9 @@
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.Metadata
  * Metadata} object, the requested
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.RatioGroupByResult
- * RatioGroupByResult} and an identifier of the object plus the corresponding
- * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.RatioResult
- * RatioResult} objects.
+ * RatioGroupByResult} for a JSON response and an identifier of the object. If the output format is
+ * GeoJSON, the response includes a {@link org.geojson.Feature Feature} array, which holds the
+ * respective objects with their timestamp-value pairs.
  */
 @JsonInclude(Include.NON_NULL)
 public class RatioGroupByBoundaryResponse implements Response {

diff --git a/...hsomeApi/output/dataAggregationResponse/groupByResponse/ShareGroupByBoundaryResponse.java b/...hsomeApi/output/dataAggregationResponse/groupByResponse/ShareGroupByBoundaryResponse.java
@@ -14,9 +14,9 @@
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.Metadata
  * Metadata} object, the requested
  * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.groupByResponse.ShareGroupByResult
- * ShareGroupByResult} and an identifier of the object plus the corresponding
- * {@link org.heigit.bigspatialdata.ohsome.ohsomeApi.output.dataAggregationResponse.elements.ShareResult
- * ShareResult} objects.
+ * ShareGroupByResult} for a JSON response and an identifier of the object. If the output format is
+ * GeoJSON, the response includes a {@link org.geojson.Feature Feature} array, which holds the
+ * respective objects with their timestamp-value pairs.
  */
 @JsonInclude(Include.NON_NULL)
 public class ShareGroupByBoundaryResponse implements Response {