Update documentation for JoinKeyFunctions

aehrc · Jul 1, 2024 · 89e5e1a · 89e5e1a
1 parent 5b5ec87
commit 89e5e1a
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 73 deletions.
diff --git a/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/BooleanLogicFunctions.java b/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/BooleanLogicFunctions.java
@@ -7,6 +7,8 @@
 /**
  * Contains functions for boolean logic.
  *
+ * @author Piotr Szul
+ * @author John Grimes
  * @see <a href="https://build.fhir.org/ig/HL7/FHIRPath/#boolean-logic">FHIRPath Specification -
  * Boolean logic</a>
  */
@@ -27,5 +29,5 @@ public class BooleanLogicFunctions {
   public static BooleanCollection not(@Nonnull final BooleanCollection input) {
     return BooleanCollection.build(input.getColumn().not());
   }
-  
+
 }
diff --git a/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/BoundaryFunctions.java b/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/BoundaryFunctions.java
@@ -23,6 +23,7 @@
 /**
  * Contains functions for calculating the low and high boundaries of a value.
  *
+ * @author John Grimes
  * @see <a
  * href="https://build.fhir.org/ig/HL7/FHIRPath/#lowboundaryprecision-integer-decimal--date--datetime--time">lowBoundary</a>
  * @see <a

diff --git a/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/ExistenceFunctions.java b/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/ExistenceFunctions.java
@@ -7,6 +7,8 @@
 /**
  * Contains functions for evaluating the existence of elements in a collection.
  *
+ * @author Piotr Szul
+ * @author John Grimes
  * @see <a href="https://build.fhir.org/ig/HL7/FHIRPath/#existence">FHIRPath Specification -
  * Existence</a>
  */

diff --git a/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/IifFunction.java b/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/IifFunction.java
diff --git a/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/JoinKeyFunctions.java b/fhirpath/src/main/java/au/csiro/pathling/fhirpath/function/JoinKeyFunctions.java
@@ -30,6 +30,9 @@
  * FHIRPath functions for generating keys for joining between resources.
  *
  * @author Piotr Szul
+ * @see <a
+ * href="https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/StructureDefinition-ViewDefinition.html#required-additional-functions">SQL
+ * on FHIR Specification - Required Additional Functions</a>
  */
 @SuppressWarnings("unused")
 public class JoinKeyFunctions {
@@ -41,7 +44,8 @@ public class JoinKeyFunctions {
    * @param input The input {@link ResourceCollection}
    * @return A {@link Collection} of keys
    * @see <a
-   * href="https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/StructureDefinition-ViewDefinition.html#getresourcekey--keytype">getResourceKey</a>
+   * href="https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/StructureDefinition-ViewDefinition.html#getresourcekey--keytype">SQL
+   * on FHIR Specification - getResourceKey</a>
    */
   @FhirPathFunction
   @Nonnull
@@ -56,7 +60,8 @@ public static Collection getResourceKey(@Nonnull final ResourceCollection input)
    * @param typeSpecifier An optional {@link TypeSpecifier} to filter the reference keys by
    * @return A {@link Collection} of keys
    * @see <a
-   * href="https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/StructureDefinition-ViewDefinition.html#getreferencekeyresource-type-specifier--keytype">getReferenceKey</a>
+   * href="https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/StructureDefinition-ViewDefinition.html#getreferencekeyresource-type-specifier--keytype">SQL
+   * on FHIR Specification - getReferenceKey</a>
    */
   @FhirPathFunction
   @Nonnull