summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBilal Alsharifi <bilal.alsharifi@gmail.com>2020-07-29 17:39:06 -0400
committerBilal Alsharifi <bilal.alsharifi@gmail.com>2020-07-29 17:39:06 -0400
commitd48c87a1b21d8a1896c9b4852ab435e73c28b8f7 (patch)
treeb1fee5206205987ad3c57cc216826c1539dcc83e
parent4a05069ae7b3de583ac1ae078d4666a26d3d34c8 (diff)
downloadsdl_android-d48c87a1b21d8a1896c9b4852ab435e73c28b8f7.tar.gz
Fix a typo in javadoc
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java2
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteractionResponse.java23
2 files changed, 11 insertions, 14 deletions
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java
index 368c635ba..7b2273c7c 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java
@@ -100,7 +100,7 @@ public class CancelInteraction extends RPCRequest {
}
/**
- * Sets hhe ID of the type of interaction the developer wants to dismiss.
+ * Sets the ID of the type of interaction the developer wants to dismiss.
* Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), 26 (SliderID), and 64 (SubtleAlertID) are permitted.
* @param functionID - the functionID
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteractionResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteractionResponse.java
index aee5bd266..defab83c9 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteractionResponse.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteractionResponse.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2017 - 2020, SmartDeviceLink Consortium, Inc.
+ * Copyright (c) 2019 Livio, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -13,9 +13,9 @@
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
- * Neither the name of the SmartDeviceLink Consortium Inc. nor the names of
- * its contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
+ * Neither the name of the Livio Inc. nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
@@ -28,7 +28,10 @@
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Created by Nicole Yarroch on 7/24/19 9:29 AM
*/
+
package com.smartdevicelink.proxy.rpc;
import android.support.annotation.NonNull;
@@ -40,18 +43,13 @@ import com.smartdevicelink.proxy.rpc.enums.Result;
import java.util.Hashtable;
/**
- * If no applicable request can be dismissed, the result will be IGNORED.
- *
- * @since SmartDeviceLink 6.0.0
+ * Response to the request to dismiss a modal view. If no applicable request can be dismissed, the `resultCode` will be `IGNORED`.
*/
public class CancelInteractionResponse extends RPCResponse {
-
/**
* Constructs a new CancelInteractionResponse object
*/
- public CancelInteractionResponse() {
- super(FunctionID.CANCEL_INTERACTION.toString());
- }
+ public CancelInteractionResponse() { super(FunctionID.CANCEL_INTERACTION.toString()); }
/**
* Constructs a new CancelInteractionResponse object indicated by the Hashtable parameter
@@ -64,9 +62,8 @@ public class CancelInteractionResponse extends RPCResponse {
/**
* Constructs a new CancelInteractionResponse object
- *
* @param success whether the request is successfully processed
- * @param resultCode additional information about a response returning a failed outcome
+ * @param resultCode whether the request is successfully processed
*/
public CancelInteractionResponse(@NonNull Boolean success, @NonNull Result resultCode) {
this();