From: George Nash <george.nash@intel.com>
Date: Thu, 5 Jan 2017 22:02:35 +0000 (-0800)
Subject: Cleanup documentation warnings found in OcDirectPairDevice.java
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b9fba738c0269c4c69b8262697de2ba1ed01e69f;p=contrib%2Fiotivity.git

Cleanup documentation warnings found in OcDirectPairDevice.java

Change-Id: Ic15c81d22e19b6714afb84f5295057c93decc652
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/16175
Reviewed-by: Larry Sachs <larry.j.sachs@intel.com>
Reviewed-by: Tim Kourt <tim.a.kourt@intel.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Rick Bell <richard.s.bell@intel.com>
---

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,