Add return docs to the function comments

aws-amplify · Dec 6, 2022 · 76e2a83 · 76e2a83
1 parent c231a02
commit 76e2a83
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/core-kotlin/src/main/java/com/amplifyframework/kotlin/geo/Geo.kt b/core-kotlin/src/main/java/com/amplifyframework/kotlin/geo/Geo.kt
@@ -26,18 +26,23 @@ import com.amplifyframework.geo.result.GeoSearchResult
 interface Geo {
     /**
      * Gets a collection of maps and their corresponding styles.
+     *
+     * @return A collection of all available [MapStyle].
      */
     suspend fun getAvailableMaps(): Collection<MapStyle>
 
     /**
      * Gets the default map and style from available maps.
+     *
+     * @return The default [MapStyle].
      */
     suspend fun getDefaultMap(): MapStyle
 
     /**
      * Uses given options to get map style descriptor JSON.
      *
      * @param options  Options to specify for this operation.
+     * @return The [MapStyleDescriptor] matching the given options.
      */
     suspend fun getMapStyleDescriptor(
         options: GetMapStyleDescriptorOptions = GetMapStyleDescriptorOptions.defaults()
@@ -48,6 +53,7 @@ interface Geo {
      *
      * @param query    Search query text.
      * @param options  Search options to use.
+     * @return The [GeoSearchResult] for the query and options.
      */
     suspend fun searchByText(
         query: String,
@@ -59,6 +65,7 @@ interface Geo {
      *
      * @param position Coordinates to look-up.
      * @param options  Search options to use.
+     * @return The [GeoSearchResult] for the position and options.
      */
     suspend fun searchByCoordinates(
         position: Coordinates,