Add Kdoc for relevance helper

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/endpoint/EndpointSearch.kt

@@ -123,6 +123,21 @@ public interface EndpointSearch {
         requestOptions: RequestOptions? = null
     ): ResponseSearch
 
+    /**
+     *  Search iteratively through the search response [ResponseSearch.hits] field to find the first response hit tha
+     *  would match against the give [match] function.
+     *  If no object has been found within the first result set, the function
+     *  will perform a new search operation on the next page of results, if any,
+     *  until a matching object is found or the end of results, whichever
+     *  happens first.
+     *  [doNotPaginate] will stop the function at the end of the first page of search results even if no object does
+     *  match.
+     *
+     *  @param match Predicate to match a given [ResponseSearch.Hit]
+     *  @param query The [Query] used to search.
+     *  @param doNotPaginate To prevent the iteration through pages of results.
+     *  @param requestOptions Configure request locally with [RequestOptions].
+     */
     tailrec suspend fun findFirstObject(
         match: (ResponseSearch.Hit) -> Boolean,
         query: Query = Query(),

src/commonMain/kotlin/com/algolia/search/model/response/ResponseSearch.kt

@@ -11,7 +11,6 @@ import com.algolia.search.model.settings.Settings
 import com.algolia.search.serialize.*
 import kotlinx.serialization.*
 import kotlinx.serialization.json.JsonElement
-import kotlinx.serialization.json.JsonLiteral
 import kotlinx.serialization.json.JsonObject
 
 
@@ -274,6 +273,10 @@ public data class ResponseSearch(
     public val hierarchicalFacets: Map<Attribute, List<Facet>>
         get() = hierarchicalFacetsOrNull!!
 
+    /**
+     * Returns the position (0-based) within the [hits] result list of the record matching against the given [objectID].
+     * If the [objectID] is not found, -1 is returned.
+     */
     public fun getObjectIDPosition(objectID: ObjectID): Int {
         return hits.indexOfFirst { it.json.getPrimitiveOrNull("objectID")?.content == objectID.raw }
     }