Itstanany/#2542 erroreneous docs search method documentation (#2543)

* fix erroneous docs * #2542/fix erroneous docs * add docs * #2542/ add docs * spotlessApply --------- Co-authored-by: Jing Tang <[email protected]>
google · Jun 8, 2024 · 69e87d7 · 69e87d7
1 parent 735fd0f
commit 69e87d7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 11 deletions.
diff --git a/engine/src/main/java/com/google/android/fhir/FhirEngine.kt b/engine/src/main/java/com/google/android/fhir/FhirEngine.kt
@@ -100,16 +100,6 @@ interface FhirEngine {
  /**
  * Searches the database and returns a list of resources matching the [Search] specifications.
  *
- * Example:
- * ```
- * fhirEngine.search<Patient> {
- * filter(Patient.GIVEN, {
- * value = "Kiran"
- * modifier = StringFilterModifier.MATCHES_EXACTLY
- * })
- * }
- * ```
- *
  * @param search The search criteria to apply.
  * @return A list of [SearchResult] objects containing the matching resources and any included
  * references.

diff --git a/engine/src/main/java/com/google/android/fhir/search/Search.kt b/engine/src/main/java/com/google/android/fhir/search/Search.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 Google LLC
+ * Copyright 2022-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,23 @@ import com.google.android.fhir.search.query.XFhirQueryTranslator.translate
 import org.hl7.fhir.r4.model.Resource
 import org.hl7.fhir.r4.model.ResourceType
 
+/**
+ * Searches the database and returns a list of resources matching the [Search] specifications.
+ *
+ * Example:
+ * ```
+ * fhirEngine.search<Patient> {
+ * filter(Patient.GIVEN, {
+ * value = "Kiran"
+ * modifier = StringFilterModifier.MATCHES_EXACTLY
+ * })
+ * }
+ * ```
+ *
+ * @param init The lambda expression used to configure the [Search] object.
+ * @return A list of [SearchResult] objects containing the matching resources and any included
+ * references.
+ */
 suspend inline fun <reified R : Resource> FhirEngine.search(
  init: Search.() -> Unit,
 ): List<SearchResult<R>> {