Cleanup documentation warnings in OcCloudProvisioning.java
authorGeorge Nash <george.nash@intel.com>
Thu, 5 Jan 2017 19:39:45 +0000 (11:39 -0800)
committerRick Bell <richard.s.bell@intel.com>
Fri, 6 Jan 2017 22:33:26 +0000 (22:33 +0000)
Change-Id: I9e256dc708c2be0be42cd035a77cf76397432678
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/16169
Reviewed-by: Larry Sachs <larry.j.sachs@intel.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Rick Bell <richard.s.bell@intel.com>
java/common/src/main/java/org/iotivity/base/OcCloudProvisioning.java

index 3e60a26..b0305d1 100755 (executable)
@@ -85,7 +85,8 @@ public class  OcCloudProvisioning {
    /**
     * Method to Request a certificate from the cloud
     * @param certificateIssueRequestListener function called by the stack on completion of request.
-    * @throws OcException
+    * @throws OcException Indicates failure requesting the certificate from the cloud.
+    *                     Use OcException.GetErrorCode() for more details.
     */
     public native void requestCertificate(
             RequestCertificateListener certificateIssueRequestListener) throws OcException;
@@ -94,7 +95,8 @@ public class  OcCloudProvisioning {
     * Method to get ACL ID for the device
     * @param deviceId device ID for which the Acl ID is requested
     * @param cloudAclIdGetByDeviceHandler function called by the stack on completion of request.
-    * @throws OcException
+    * @throws OcException Indicates failure getting ACL ID for the device.
+    *                     Use OcException.GetErrorCode() for more details.
     */
     public native void getAclIdByDevice(String deviceId,
             GetAclIdByDeviceListener cloudAclIdGetByDeviceHandler) throws OcException;
@@ -103,7 +105,8 @@ public class  OcCloudProvisioning {
     * Method to get ACL information about the given Acl ID
     * @param aclId ACL ID for which the Acl information is requested
     * @param cloudAclIndividualGetInfoHandler function called by the stack on completion of request.
-    * @throws OcException
+    * @throws OcException Indicates failure to get ACL information.
+    *                     Use OcException.GetErrorCode() for more details.
     */
     public native void getIndividualAclInfo(String aclId,
             GetIndividualAclInfoListener cloudAclIndividualGetInfoHandler) throws OcException;
@@ -111,7 +114,8 @@ public class  OcCloudProvisioning {
    /**
     * Method to get certificate revocation list
     * @param cloudGetCRLHandler function called by the stack on completion of request.
-    * @throws OcException
+    * @throws OcException Indicates failure to get certificate revocation list.
+    *                     Use OcException.GetErrorCode() for more details.
     */
     public native void getCRL(GetCRLListener cloudGetCRLHandler)
             throws OcException;
@@ -123,7 +127,8 @@ public class  OcCloudProvisioning {
     * @param crl revocation list [optional].
     * @param serialNumbers [optional].
     * @param cloudPostCRLHandler function called by the stack on completion of request.
-    * @throws OcException
+    * @throws OcException Indicates failure posting the certificate revocation list to cloud.
+    *                     Use OcException.GetErrorCode() for more details.
     */
     public void postCRL(String thisUpdate, String nextUpdate, String crl, ArrayList<String> serialNumbers,
                                     PostCRLListener cloudPostCRLHandler) throws OcException