From b9fba738c0269c4c69b8262697de2ba1ed01e69f Mon Sep 17 00:00:00 2001 From: George Nash Date: Thu, 5 Jan 2017 14:02:35 -0800 Subject: [PATCH] Cleanup documentation warnings found in OcDirectPairDevice.java Change-Id: Ic15c81d22e19b6714afb84f5295057c93decc652 Signed-off-by: George Nash Reviewed-on: https://gerrit.iotivity.org/gerrit/16175 Reviewed-by: Larry Sachs Reviewed-by: Tim Kourt Tested-by: jenkins-iotivity Reviewed-by: Rick Bell --- .../src/main/java/org/iotivity/base/OcDirectPairDevice.java | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/java/common/src/main/java/org/iotivity/base/OcDirectPairDevice.java b/java/common/src/main/java/org/iotivity/base/OcDirectPairDevice.java index 55b4dd6..57c7475 100644 --- a/java/common/src/main/java/org/iotivity/base/OcDirectPairDevice.java +++ b/java/common/src/main/java/org/iotivity/base/OcDirectPairDevice.java @@ -81,7 +81,8 @@ public class OcDirectPairDevice { * Method to get list of all paired devices for a given device. * * @param getDirectPairedListener Callback function, which will receive the list of direct paired devices. - * @throws OcException + * @throws OcException Indicate failure to list paired devices. + * Use OcException.GetErrorCode() for more details. */ public native void getDirectPairedDevices(GetDirectPairedListener getDirectPairedListener) throws OcException; @@ -93,9 +94,13 @@ public class OcDirectPairDevice { /** * Method to perform direct pairing between two devices. * + * @param peer the peer device + * @param pmSel direct pairing Method Type ( DP_NOT_ALLOWED, DP_PRE_CONFIGURED, DP_RANDOM_PIN ) + * @param pinNumber pairing pin number * @param directPairingListener Callback function, which will be called after - * completion of direct pairing. - * @throws OcException + * completion of direct pairing. + * @throws OcException Indicate failure to perform direct pairing between devices. + * Use OcException.GetErrorCode() for more details. */ public native void doDirectPairing(OcDirectPairDevice peer, OcPrmType pmSel, String pinNumber, -- 2.7.4