From 431ebc29f000c79c5fd822c1459fc9be95f144be Mon Sep 17 00:00:00 2001
From: "Alex J Hawk (HMS)" <51409174+alexjhawk@users.noreply.github.com>
Date: Tue, 14 May 2024 09:11:21 -0400
Subject: [PATCH] Update DataPoint#valueEquals Javadoc

Updated the Javadoc of the DataPoint#valueEquals
method so that it identifies that true is only
returned when the data point type is also the same.
---
 .../americas/sc/extensions/datapoint/DataPoint.java             | 2 +-
 .../americas/sc/extensions/datapoint/DataPointBoolean.java      | 2 +-
 .../americas/sc/extensions/datapoint/DataPointDword.java        | 2 +-
 .../americas/sc/extensions/datapoint/DataPointFloat.java        | 2 +-
 .../americas/sc/extensions/datapoint/DataPointInteger.java      | 2 +-
 .../americas/sc/extensions/datapoint/DataPointString.java       | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java
index 0bcde839..d75614b3 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java
@@ -136,7 +136,7 @@ public String toString() {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public abstract boolean valueEquals(DataPoint p);
 
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java
index 7d7ec0ff..55253cb4 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java
index 8fc60749..9bf21126 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java
index b2a8c969..e2ee294c 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java
index bd650f6c..e3b0c299 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java
index 28f5745e..6833fda7 100644
--- a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java
+++ b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;