From 50c9c25c6489abbcdae0e8854746acbe2dfdce52 Mon Sep 17 00:00:00 2001 From: Youngman Date: Tue, 24 Jan 2017 14:24:41 +0900 Subject: [PATCH] Correct the errata in docs related to security Change-Id: I3f16e16cd4fff4fce1006672478337965e2f9d11 Signed-off-by: Youngman Reviewed-on: https://gerrit.iotivity.org/gerrit/16721 Tested-by: jenkins-iotivity Reviewed-by: Randeep Singh Reviewed-on: https://gerrit.iotivity.org/gerrit/17369 Reviewed-by: Jongmin Choi Reviewed-by: Chul Lee --- .../csdk/connectivity/api/casecurityinterface.h | 2 +- .../csdk/security/include/internal/aclresource.h | 2 +- .../csdk/security/include/internal/amaclresource.h | 2 +- .../csdk/security/include/internal/credresource.h | 2 +- .../csdk/security/include/internal/crlresource.h | 4 ++-- .../csdk/security/include/internal/directpairing.h | 2 +- .../csdk/security/include/internal/doxmresource.h | 2 +- .../csdk/security/include/internal/pconfresource.h | 2 +- .../csdk/security/include/internal/psinterface.h | 2 +- .../csdk/security/include/internal/pstatresource.h | 5 +++-- .../security/include/internal/security_internals.h | 2 +- .../csdk/security/include/internal/svcresource.h | 2 +- .../csdk/security/include/internal/verresource.h | 6 +++--- resource/csdk/security/include/iotvticalendar.h | 4 ++-- resource/csdk/security/include/oxmverifycommon.h | 16 ++++++++-------- resource/csdk/security/include/pbkdf2.h | 8 ++++---- .../security/include/securevirtualresourcetypes.h | 2 +- resource/csdk/security/include/srmutility.h | 6 +++--- .../include/internal/credentialgenerator.h | 2 +- .../internal/multipleownershiptransfermanager.h | 10 +++++++--- .../include/internal/ownershiptransfermanager.h | 6 +++--- .../include/internal/provisioningdatabasemanager.h | 2 +- .../include/internal/secureresourceprovider.h | 16 +++++++++++----- .../provisioning/include/ocprovisioningmanager.h | 22 ++++++++++++---------- .../provisioning/include/oxm/oxmjustworks.h | 10 +++++----- .../provisioning/include/oxm/oxmmanufacturercert.h | 12 ++++++------ .../provisioning/include/oxm/oxmpreconfpin.h | 12 ++++++------ .../provisioning/include/oxm/oxmrandompin.h | 12 ++++++------ .../csdk/security/provisioning/include/pmtypes.h | 16 ++++++++-------- .../csdk/security/provisioning/include/pmutility.h | 4 ++-- resource/docs/c-doc/Doxyfile | 5 +---- resource/include/OCProvisioningManager.hpp | 10 +++------- 32 files changed, 108 insertions(+), 102 deletions(-) diff --git a/resource/csdk/connectivity/api/casecurityinterface.h b/resource/csdk/connectivity/api/casecurityinterface.h index 32b09dc..8a39fc8 100644 --- a/resource/csdk/connectivity/api/casecurityinterface.h +++ b/resource/csdk/connectivity/api/casecurityinterface.h @@ -119,7 +119,7 @@ CAResult_t CAregisterSslHandshakeCallback(CAErrorCallback tlsHandshakeCallback); /** * Register callback to get TLS PSK credentials. - * @param[in] getTLSCredentials GetDTLS Credetials callback. + * @param[in] getTlsCredentials GetDTLS Credetials callback. * @return ::CA_STATUS_OK */ CAResult_t CAregisterPskCredentialsHandler(CAgetPskCredentialsHandler getTlsCredentials); diff --git a/resource/csdk/security/include/internal/aclresource.h b/resource/csdk/security/include/internal/aclresource.h index 0172ae4..dec810a 100644 --- a/resource/csdk/security/include/internal/aclresource.h +++ b/resource/csdk/security/include/internal/aclresource.h @@ -172,7 +172,7 @@ OCStackResult GetAclRownerId(OicUuid_t *rowneruuid); * @param cborPayload is the pointer to cbor payload to parse. * @param size of the cbor payload. * - * @return ::acl instance of @ref OicSecAcl_t structure or NULL if error occurs + * @return instance of @ref OicSecAcl_t structure or NULL if error occurs */ OicSecAcl_t* CBORPayloadToAcl2(const uint8_t *cborPayload, const size_t size); diff --git a/resource/csdk/security/include/internal/amaclresource.h b/resource/csdk/security/include/internal/amaclresource.h index 052b959..d7a524a 100644 --- a/resource/csdk/security/include/internal/amaclresource.h +++ b/resource/csdk/security/include/internal/amaclresource.h @@ -67,7 +67,7 @@ OCStackResult AmaclGetAmsDeviceId(const char *resource, OicUuid_t *amsId); * @param cborSize is the size of the cbor payload. This value is the size of the * cborPayload. It should not be NON-NULL value. * - * @return ::OC_STACK_OK for Success. ::OC_STACK_INVALID in case of invalid parameters. + * @return ::OC_STACK_OK for Success. ::OC_STACK_INVALID_PARAM in case of invalid parameters. * ::OC_STACK_ERROR in case of error in converting to cbor. */ OCStackResult AmaclToCBORPayload(const OicSecAmacl_t *amacl, uint8_t **cborPayload, diff --git a/resource/csdk/security/include/internal/credresource.h b/resource/csdk/security/include/internal/credresource.h index 872555c..8299eff 100644 --- a/resource/csdk/security/include/internal/credresource.h +++ b/resource/csdk/security/include/internal/credresource.h @@ -180,7 +180,7 @@ OCStackResult AddTmpPskWithPIN(const OicUuid_t* tmpSubject, OicSecCredType_t cre /** * Function to getting credential list * - * @return ::credential list + * @return instance of @ref OicSecCred_t */ const OicSecCred_t* GetCredList(); diff --git a/resource/csdk/security/include/internal/crlresource.h b/resource/csdk/security/include/internal/crlresource.h index 349c41b..20acfe4 100644 --- a/resource/csdk/security/include/internal/crlresource.h +++ b/resource/csdk/security/include/internal/crlresource.h @@ -74,7 +74,7 @@ OCStackResult CrlToCBORPayload(const OicSecCrl_t *crl, uint8_t **payload, size_t * will be allocated by the function and content of *crl will be ignored. * @param cborPayload is the cbor vlaue * @param size is a pointer to length of the CRL buffer. Should be not NULL. - * @param crl is a pointer to buffer that contains crl. Shoul be not NULL. Buffer + * @param secCrl is a pointer to buffer that contains crl. Shoul be not NULL. Buffer * * @note Caller responsible for crl buffer memory (use OICFree to free it). * @@ -99,7 +99,7 @@ OCStackResult DeInitCRLResource(); /** * Get an instance of CRL resource. * - * @return reference to the @ref OicSecCrl_t, holding reference to CRL resource. + * @return reference to the OicSecCrl_t, holding reference to CRL resource. */ OicSecCrl_t *GetCRLResource(); diff --git a/resource/csdk/security/include/internal/directpairing.h b/resource/csdk/security/include/internal/directpairing.h index 328523d..4732756 100644 --- a/resource/csdk/security/include/internal/directpairing.h +++ b/resource/csdk/security/include/internal/directpairing.h @@ -32,7 +32,7 @@ extern "C" #endif /** - * Discover direct-pairing devices in the same IP subnet. . + * Discover direct-pairing devices in the same IP subnet. * * @param[in] waittime Timeout in seconds. * diff --git a/resource/csdk/security/include/internal/doxmresource.h b/resource/csdk/security/include/internal/doxmresource.h index 16afdf5..2aaf0c4 100644 --- a/resource/csdk/security/include/internal/doxmresource.h +++ b/resource/csdk/security/include/internal/doxmresource.h @@ -45,7 +45,7 @@ OCStackResult InitDoxmResource(); OCStackResult DeInitDoxmResource(); /** - * This method is used by SRM to retrieve DOXM resource data.. + * This method is used by SRM to retrieve DOXM resource data. * * @return reference to @ref OicSecDoxm_t, binary format of Doxm resource data. */ diff --git a/resource/csdk/security/include/internal/pconfresource.h b/resource/csdk/security/include/internal/pconfresource.h index 4ad7baf..8a3ffc7 100644 --- a/resource/csdk/security/include/internal/pconfresource.h +++ b/resource/csdk/security/include/internal/pconfresource.h @@ -42,7 +42,7 @@ OCStackResult InitPconfResource(); OCStackResult DeInitPconfResource(); /** - * This method is used by SRM to retrieve PCONF resource data.. + * This method is used by SRM to retrieve PCONF resource data. * * @retval reference to @ref OicSecPconf_t, binary format of Pconf resource data */ diff --git a/resource/csdk/security/include/internal/psinterface.h b/resource/csdk/security/include/internal/psinterface.h index 15c5e7f..ea7e986 100644 --- a/resource/csdk/security/include/internal/psinterface.h +++ b/resource/csdk/security/include/internal/psinterface.h @@ -52,7 +52,7 @@ OCStackResult GetSecureVirtualDatabaseFromPS(const char *rsrcName, uint8_t **dat * * @param rsrcName is the name of the secure resource that will be updated. * @param cborPayload is the pointer holding cbor payload. - * @param cborPayload is the size of the cbor payload. + * @param size is the size of the cbor payload. * * @return ::OC_STACK_OK for Success, otherwise some error value */ diff --git a/resource/csdk/security/include/internal/pstatresource.h b/resource/csdk/security/include/internal/pstatresource.h index 5f0959c..5ccc94a 100644 --- a/resource/csdk/security/include/internal/pstatresource.h +++ b/resource/csdk/security/include/internal/pstatresource.h @@ -44,8 +44,9 @@ OCStackResult DeInitPstatResource(); * * @param pstat pointer to the initialized pstat structure. * @param cborPayload pointer to pstat cbor payload. - * @param size of the cbor payload converted. It is 0 in case of error, + * @param cborSize of the cbor payload converted. It is 0 in case of error, * else a positive value if succcessful. + * @param writableOnly indicates whether it is writable only or not. * * @return ::OC_STACK_OK for Success, otherwise some error value. */ @@ -56,7 +57,7 @@ OCStackResult DeInitPstatResource(); * This method converts cbor into PSTAT data. * * @param cborPayload is the pstat data in cbor format. - * @param size of the cborPayload. In case 0 is provided it assigns CBOR_SIZE (255) value. + * @param cborSize of the cborPayload. In case 0 is provided it assigns CBOR_SIZE (255) value. * @param pstat pointer to @ref OicSecPstat_t. * * @return ::OC_STACK_OK for Success, otherwise some error value. diff --git a/resource/csdk/security/include/internal/security_internals.h b/resource/csdk/security/include/internal/security_internals.h index 13030d9..3a805df 100644 --- a/resource/csdk/security/include/internal/security_internals.h +++ b/resource/csdk/security/include/internal/security_internals.h @@ -49,7 +49,7 @@ OCStackResult SetDefaultACL(OicSecAcl_t *acl); * Converts CBOR payload to SVC. * * @param cborPayload is the svc payload cbor value that neds to be converted. - * @param cborSize of the cborPayload. In case size is not known, it is 0. + * @param size of the cborPayload. In case size is not known, it is 0. * @param svc is the value that is initialized. It is NULL in case of error. * * @return ::OC_STACK_OK in case successful. ::OC_STACK_INVALID_PARAM if one of diff --git a/resource/csdk/security/include/internal/svcresource.h b/resource/csdk/security/include/internal/svcresource.h index ce759f8..e6ff9bc 100644 --- a/resource/csdk/security/include/internal/svcresource.h +++ b/resource/csdk/security/include/internal/svcresource.h @@ -47,7 +47,7 @@ void DeInitSVCResource(); * @param cborSize is the size of the cbor payload. This value is the size of the * cborPayload. It should not be NON-NULL value. * - * @return ::OC_STACK_OK for Success. ::OC_STACK_INVALID in case of invalid parameters. + * @return ::OC_STACK_OK for Success. ::OC_STACK_INVALID_PARAM in case of invalid parameters. * ::OC_STACK_ERROR in case of error in converting to cbor. */ OCStackResult SVCToCBORPayload(const OicSecSvc_t *svc, uint8_t **cborPayload, diff --git a/resource/csdk/security/include/internal/verresource.h b/resource/csdk/security/include/internal/verresource.h index 18fa03d..db050d3 100644 --- a/resource/csdk/security/include/internal/verresource.h +++ b/resource/csdk/security/include/internal/verresource.h @@ -42,7 +42,7 @@ OCStackResult InitVerResource(); OCStackResult DeInitVerResource(); /** - * This method is used by SRM to retrieve VER resource data.. + * This method is used by SRM to retrieve VER resource data. * * @return reference to @ref OicSecDoxm_t, binary format of Doxm resource data. */ @@ -55,8 +55,8 @@ const OicSecVer_t* GetVerResourceData(); * * @param cborPayload is a ver data in cbor. * @note Caller needs to invoke OCFree after done using the return pointer. - * @param doxm is the pointer to @ref OicSecVer_t. * @param size of the cborPayload. In case value is 0, CBOR_SIZE value is assigned. + * @param ver is the pointer to @ref OicSecVer_t. * * @return ::OC_STACK_OK for Success, otherwise some error value. */ @@ -95,4 +95,4 @@ void DeleteVerBinData(OicSecVer_t* ver); } #endif -#endif //IOTVT_SRM_VER_H \ No newline at end of file +#endif //IOTVT_SRM_VER_H diff --git a/resource/csdk/security/include/iotvticalendar.h b/resource/csdk/security/include/iotvticalendar.h index 1fec23e..3d1269a 100644 --- a/resource/csdk/security/include/iotvticalendar.h +++ b/resource/csdk/security/include/iotvticalendar.h @@ -107,7 +107,7 @@ struct IotvtICalPeriod IotvtICalDateTime_t endDateTime; }; -/* +/** * Grammar for iCalendar data type RECUR. * * recur = "FREQ"=freq *( @@ -169,7 +169,7 @@ IotvtICalResult_t IsRequestWithinValidTime(const char *period, const char *recur * @return ::IOTVTICAL_VALID_ACCESS, if the request is within valid time period * ::IOTVTICAL_INVALID_PARAMETER, if parameter are invalid * ::IOTVTICAL_INVALID_PERIOD, if period string has invalid format - * ::IOTVTICAL_INVALID_SUCCESS, if no error while parsing. + * ::IOTVTICAL_SUCCESS, if no error while parsing. */ IotvtICalResult_t ParsePeriod(const char *periodStr, IotvtICalPeriod_t *period); diff --git a/resource/csdk/security/include/oxmverifycommon.h b/resource/csdk/security/include/oxmverifycommon.h index bc1b2df..e3ef033 100644 --- a/resource/csdk/security/include/oxmverifycommon.h +++ b/resource/csdk/security/include/oxmverifycommon.h @@ -34,7 +34,7 @@ /** Label Length */ #define LABEL_LEN (30) -/* Verification Method Option definition +/** Verification Method Option definition * This type supports multiple bit set. */ typedef enum VerifyOptionBitmask @@ -49,7 +49,7 @@ */ typedef OCStackResult (*DisplayNumCallback)(void * ctx, uint8_t verifNum[MUTUAL_VERIF_NUM_LEN]); -/* +/** * Function pointer to get user confirmation */ typedef OCStackResult (*UserConfirmCallback)(void * ctx); @@ -72,33 +72,33 @@ typedef struct UserConfirmContext void * context; } UserConfirmContext_t; -/* +/** * Set Callback for displaying verification PIN */ void SetDisplayNumCB(void * ptr, DisplayNumCallback displayNumCB); -/* +/** * Unset Callback for displaying verification PIN */ void* UnsetDisplayNumCB(); -/* +/** * Set Callback for getting user confirmation */ void SetUserConfirmCB(void * ptr, UserConfirmCallback userConfirmCB); -/* +/** * Unset Callback for getting user confirmation */ void* UnsetUserConfirmCB(); -/* +/** * Set verification method option. * The default is both display PIN and get user confirmation. */ void SetVerifyOption(VerifyOptionBitmask_t verifyOption); -/* +/** * Call the Callback for Verifying Ownership Transfer process. */ OCStackResult VerifyOwnershipTransfer(uint8_t mutualVerifNum[MUTUAL_VERIF_NUM_LEN], diff --git a/resource/csdk/security/include/pbkdf2.h b/resource/csdk/security/include/pbkdf2.h index 9a05d79..9bcb608 100644 --- a/resource/csdk/security/include/pbkdf2.h +++ b/resource/csdk/security/include/pbkdf2.h @@ -31,8 +31,8 @@ extern "C" /** * The number of iterations desired to derived key. - * As specified in the OCF Security Specification. This choice is required for - * interoperability in the Random PIN OTM. + * As specified in the OCF Security Specification. This choice is required for + * interoperability in the Random PIN OTM. */ #define PBKDF_ITERATIONS 1000 @@ -43,8 +43,8 @@ extern "C" * @param passwd is the master password from which a derived key is generated. * @param pLen is the byte size of the passwd. * @param salt is a cryptographic salt. - * @param saltlen is the byte size of the salt. - * @param iteration is the number of iterations desired. + * @param saltLen is the byte size of the salt. + * @param iterations is the number of iterations desired. * @param keyLen is the desired byte size of the derived key. (should be the same as * derivedKey size) * @param derivedKey is the generated derived key diff --git a/resource/csdk/security/include/securevirtualresourcetypes.h b/resource/csdk/security/include/securevirtualresourcetypes.h index 25d1e19..cd34e43 100644 --- a/resource/csdk/security/include/securevirtualresourcetypes.h +++ b/resource/csdk/security/include/securevirtualresourcetypes.h @@ -298,7 +298,7 @@ typedef enum }MotStatus_t; #endif //MULTIPLE_OWNER -/* +/** * oic.sec.mom type definition * TODO: This type will be included to OIC Security Spec. * 0 : Disable multiple owner diff --git a/resource/csdk/security/include/srmutility.h b/resource/csdk/security/include/srmutility.h index 38c42bd..4bd55eb 100644 --- a/resource/csdk/security/include/srmutility.h +++ b/resource/csdk/security/include/srmutility.h @@ -107,13 +107,13 @@ OicParseQueryIter_t * GetNextQuery(OicParseQueryIter_t * parseIter); /** * Function to getting string of ownership transfer method * - * @prarm oxmType ownership transfer method + * @param oxmType ownership transfer method * * @return string value of ownership transfer method */ const char* GetOxmString(OicSecOxm_t oxmType); -/* +/** * This method converts UUID to canonical format string. * * @param uuid Device UUID @@ -125,7 +125,7 @@ const char* GetOxmString(OicSecOxm_t oxmType); OCStackResult ConvertUuidToStr(const OicUuid_t* uuid, char** strUuid); -/* +/** * This method converts string UUID to OicUuid_t. * * @param strUuid Device UUID in string format diff --git a/resource/csdk/security/provisioning/include/internal/credentialgenerator.h b/resource/csdk/security/provisioning/include/internal/credentialgenerator.h index b87dd56..4e69acb 100644 --- a/resource/csdk/security/provisioning/include/internal/credentialgenerator.h +++ b/resource/csdk/security/provisioning/include/internal/credentialgenerator.h @@ -32,7 +32,7 @@ extern "C" { * Function to generate credentials according to the type. * * @param[in] type Type of credential. - * @param[in] keysize size of key. + * @param[in] keySize size of key. * @param[in] ptDeviceId Device ID of provisioning tool. * @param[in] firstDeviceId DeviceID of the first device. * @param[in] secondDeviceId DeviceID of the second device. diff --git a/resource/csdk/security/provisioning/include/internal/multipleownershiptransfermanager.h b/resource/csdk/security/provisioning/include/internal/multipleownershiptransfermanager.h index cd35605..c0e4798 100644 --- a/resource/csdk/security/provisioning/include/internal/multipleownershiptransfermanager.h +++ b/resource/csdk/security/provisioning/include/internal/multipleownershiptransfermanager.h @@ -37,6 +37,7 @@ extern "C" { /** * API to add 'doxm.oxms' to resource server. * + * @param[in] ctx Application context would be returned in result callback * @param[in] targetDeviceInfo Selected target device. * @param[in] newOxm OxMs to be added (ref. oic.sec.oxm) * @param[in] resultCallback callback provided by API user, callback will be called when @@ -49,6 +50,7 @@ OCStackResult MOTAddMOTMethod(void *ctx, OCProvisionDev_t *targetDeviceInfo, /** * API to update 'doxm.oxmsel' to resource server. * + * @param[in] ctx Application context would be returned in result callback * @param[in] targetDeviceInfo Selected target device. * @param[in] oxmSelValue Method of multiple ownership transfer (ref. oic.sec.oxm) * @param[in] resultCallback callback provided by API user, callback will be called when @@ -61,6 +63,7 @@ OCStackResult MOTSelectMOTMethod(void *ctx, const OCProvisionDev_t *targetDevice /** * API to update 'doxm.mom' to resource server. * + * @param[in] ctx Application context would be returned in result callback * @param[in] targetDeviceInfo Selected target device. * @param[in] momType Mode of multiple ownership transfer (ref. oic.sec.mom) * @param[in] resultCallback callback provided by API user, callback will be called when @@ -73,6 +76,7 @@ OCStackResult MOTChangeMode(void *ctx, const OCProvisionDev_t *targetDeviceInfo, /** * API to provision preconfigured PIN to resource server. * + * @param[in] ctx Application context would be returned in result callback * @param[in] targetDeviceInfo Selected target device. * @param[in] preconfPIN Preconfig PIN which is used while multiple owner authentication * @param[in] preconfPINLen Byte length of preconfig PIN @@ -91,8 +95,8 @@ OCStackResult MOTProvisionPreconfigPIN(void *ctx, const OCProvisionDev_t *target * API to perform the multiple ownership transfer. * * @param[in] ctx Application context would be returned in result callback - * @param[in] selectedDeviceList linked list of multiple ownership transfer candidate devices. - * @param[in] resultCB Result callback function to be invoked when multiple ownership transfer finished. + * @param[in] selectedDevicelist linked list of multiple ownership transfer candidate devices. + * @param[in] resultCallback Result callback function to be invoked when multiple ownership transfer finished. * @return OC_STACK_OK in case of success and other value otherwise. */ OCStackResult MOTDoOwnershipTransfer(void* ctx, @@ -114,4 +118,4 @@ OCStackResult MOTAddPreconfigPIN(const OCProvisionDev_t *targetDeviceInfo, #ifdef __cplusplus } #endif -#endif //OTM_MULTIPLE_OWNERSHIPTRANSFERMANAGER_H_ \ No newline at end of file +#endif //OTM_MULTIPLE_OWNERSHIPTRANSFERMANAGER_H_ diff --git a/resource/csdk/security/provisioning/include/internal/ownershiptransfermanager.h b/resource/csdk/security/provisioning/include/internal/ownershiptransfermanager.h index 2ed1f91..3514a50 100644 --- a/resource/csdk/security/provisioning/include/internal/ownershiptransfermanager.h +++ b/resource/csdk/security/provisioning/include/internal/ownershiptransfermanager.h @@ -58,7 +58,7 @@ OCStackResult OTMDoOwnershipTransfer(void* ctx, OCStackResult OTMSetOxmAllowStatus(const OicSecOxm_t oxm, const bool allowStatus); -/* +/** *Callback for load secret for temporal secure session * * e.g) in case of PIN based, input the pin through this callback @@ -66,12 +66,12 @@ OCStackResult OTMSetOxmAllowStatus(const OicSecOxm_t oxm, const bool allowStatus */ typedef OCStackResult (*OTMLoadSecret)(OTMContext_t* otmCtx); -/* +/** * Callback for create secure channel using secret inputed from OTMLoadSecret callback */ typedef OCStackResult (*OTMCreateSecureSession)(OTMContext_t* otmCtx); -/* +/** * Callback for creating CoAP payload. */ typedef OCStackResult (*OTMCreatePayloadCallback)(OTMContext_t* otmCtx, uint8_t **payload, diff --git a/resource/csdk/security/provisioning/include/internal/provisioningdatabasemanager.h b/resource/csdk/security/provisioning/include/internal/provisioningdatabasemanager.h index e0dc2b0..dd1801b 100644 --- a/resource/csdk/security/provisioning/include/internal/provisioningdatabasemanager.h +++ b/resource/csdk/security/provisioning/include/internal/provisioningdatabasemanager.h @@ -150,7 +150,7 @@ OCStackResult PDMSetLinkStale(const OicUuid_t* uuidOfDevice1, const OicUuid_t* u * * @note in case of sqllite, the caller should set NULL for parameters. * - * @param[out] staleDevices information about the list of "To be Removed" devices' uuid. + * @param[out] staleDevList information about the list of "To be Removed" devices' uuid. * @param[out] numOfDevices total number of devices to be removed. * * @return OC_STACK_OK in case of success and other value otherwise. diff --git a/resource/csdk/security/provisioning/include/internal/secureresourceprovider.h b/resource/csdk/security/provisioning/include/internal/secureresourceprovider.h index a66f546..605835d 100644 --- a/resource/csdk/security/provisioning/include/internal/secureresourceprovider.h +++ b/resource/csdk/security/provisioning/include/internal/secureresourceprovider.h @@ -35,6 +35,7 @@ extern "C" /** * API to send ACL information to resource. * + * @param[in] ctx Application context would be returned in result callback. * @param[in] selectedDeviceInfo Selected target device. * @param[in] acl ACL to provision. * @param[in] resultCallback callback provided by API user, callback will be called when @@ -55,6 +56,7 @@ OCStackResult SRPSaveACL(const OicSecAcl_t *acl); /** * API to request CRED information to resource. * + * @param[in] ctx Application context would be returned in result callback. * @param[in] selectedDeviceInfo Selected target device. * @param[in] resultCallback callback provided by API user, callback will be called when * provisioning request recieves a response from resource server. @@ -66,6 +68,7 @@ OCStackResult SRPGetCredResource(void *ctx, const OCProvisionDev_t *selectedDevi /** * API to request ACL information to resource. * + * @param[in] ctx Application context would be returned in result callback. * @param[in] selectedDeviceInfo Selected target device. * @param[in] resultCallback callback provided by API user, callback will be called when * provisioning request recieves a response from resource server. @@ -131,6 +134,7 @@ void SRPRemoveTrustCertChainNotifier(void); /** * API to send Direct-Pairing Configuration to a device. * + * @param[in] ctx Application context would be returned in result callback. * @param[in] selectedDeviceInfo Selected target device. * @param[in] pconf PCONF pointer. * @param[in] resultCallback callback provided by API user, callback will be called when @@ -155,7 +159,9 @@ OCStackResult SRPProvisionDirectPairing(void *ctx, const OCProvisionDev_t *selec /** * API to provision credential to devices. * + * @param[in] ctx Application context would be returned in result callback. * @param[in] type Type of credentials to be provisioned to the device. + * @param[in] keySize size of key * @param[in] pDev1 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned. @param[in] pDev2 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned. * @param[in] resultCallback callback provided by API user, callback will be called when @@ -184,7 +190,7 @@ OCStackResult SRPUnlinkDevices(void* ctx, const OCProvisionDev_t* pTargetDev2, OCProvisionResultCB resultCallback); -/* +/** * Function to device revocation. * This function will remove credential of target device from all devices in subnet. * @@ -203,7 +209,7 @@ OCStackResult SRPRemoveDevice(void* ctx, const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback); -/* +/** * Function to device revocation * This function will remove credential of target device from all devices in subnet. * @@ -219,7 +225,7 @@ OCStackResult SRPRemoveDevice(void* ctx, OCStackResult SRPRemoveDeviceWithoutDiscovery(void* ctx, const OCProvisionDev_t* pOwnedDevList, const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback); -/* +/** * Function to sync-up credential and ACL of the target device. * This function will remove credential and ACL of target device from all devices in subnet. * @@ -236,7 +242,7 @@ OCStackResult SRPRemoveDeviceWithoutDiscovery(void* ctx, const OCProvisionDev_t* OCStackResult SRPSyncDevice(void* ctx, unsigned short waitTimeForOwnedDeviceDiscovery, const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback); -/* +/** * Function for remote reset * This function will send pstat POST(modify) message to the target device * to change current mode to reset state in order to initiate remote reset. @@ -252,7 +258,7 @@ OCStackResult SRPSyncDevice(void* ctx, unsigned short waitTimeForOwnedDeviceDisc OCStackResult SRPResetDevice(const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback); -/* +/** * Function to read Trust certificate chain from SVR. * Caller must free when done using the returned trust certificate * @param[in] credId CredId of trust certificate chain in SVR. diff --git a/resource/csdk/security/provisioning/include/ocprovisioningmanager.h b/resource/csdk/security/provisioning/include/ocprovisioningmanager.h index b205467..98e0880 100644 --- a/resource/csdk/security/provisioning/include/ocprovisioningmanager.h +++ b/resource/csdk/security/provisioning/include/ocprovisioningmanager.h @@ -79,7 +79,7 @@ OCStackResult OCDiscoverSingleDeviceInUnicast(unsigned short timeout, const OicU * all the device in subnet which are not yet owned. Please call OCInit with OC_CLIENT_SERVER as * OCMode. * - * @param[in] timeout Timeout in seconds, value till which function will listen to responses from + * @param[in] waittime Timeout in seconds, value till which function will listen to responses from * server before returning the list of devices. * @param[out] ppList List of candidate devices to be provisioned * @return OTM_SUCCESS in case of success and other value otherwise. @@ -125,8 +125,8 @@ OCStackResult OCDoMultipleOwnershipTransfer(void* ctx, /** * API to register for particular OxM. * - * @param[in] Ownership transfer method. - * @param[in] Implementation of callback functions for owership transfer. + * @param[in] oxm transfer method. + * @param[in] callbackData of callback functions for owership transfer. * @return OC_STACK_OK in case of success and other value otherwise. */ OCStackResult OCSetOwnerTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData); @@ -194,10 +194,11 @@ OCStackResult OCIsSubownerOfDevice(OCProvisionDev_t *device, bool *isSubowner); * * @param[in] ctx Application context would be returned in result callback. * @param[in] type Type of credentials to be provisioned to the device. + * @param[in] keySize size of key * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned. - * @param[in] acl ACL for device 1. If this is not required set NULL. + * @param[in] pDev1Acl ACL for device 1. If this is not required set NULL. * @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned. - * @param[in] acl ACL for device 2. If this is not required set NULL. + * @param[in] pDev2Acl ACL for device 2. If this is not required set NULL. * @param[in] resultCallback callback provided by API user, callback will be called when * provisioning request recieves a response from first resource server. * @return OC_STACK_OK in case of success and other value otherwise. @@ -270,6 +271,7 @@ OCStackResult OCProvisionDirectPairing(void* ctx, const OCProvisionDev_t *select * * @param[in] ctx Application context would be returned in result callback. * @param[in] type Type of credentials to be provisioned to the device. + * @param[in] keySize size of key * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned. @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned. * @param[in] resultCallback callback provided by API user, callback will be called when @@ -373,13 +375,13 @@ OCStackResult OCRemoveDevice(void* ctx, const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback); -/* +/** * Function to device revocation * This function will remove credential of target device from all devices in subnet. * * @param[in] ctx Application context would be returned in result callback * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds) -* @param[in] pTargetDev Device information to be revoked. +* @param[in] pTargetUuid Device information to be revoked. * @param[in] resultCallback callback provided by API user, callback will be called when * credential revocation is finished. * @return OC_STACK_OK in case of success and other value otherwise. @@ -389,7 +391,7 @@ OCStackResult OCRemoveDeviceWithUuid(void* ctx, const OicUuid_t* pTargetUuid, OCProvisionResultCB resultCallback); -/* +/** * Function to reset the target device. * This function will remove credential and ACL of target device from all devices in subnet. * @@ -428,7 +430,7 @@ OCStackResult OCConfigSelfOwnership(void); * NOTE: Caller need to call OCDeleteDiscoveredDevices to delete memory allocated by this API for out * variables pOwnedDevList and pUnownedDevList. * - * @param[in] waitime Wait time for the API. The wait time will be divided by 2, and half of wait time + * @param[in] waittime Wait time for the API. The wait time will be divided by 2, and half of wait time * will be used for unowned discovery and remaining half for owned discovery. So the wait time should be * equal to or more than 2. * @param[out] pOwnedDevList list of owned devices. @@ -530,7 +532,7 @@ OCStackResult OCRegisterTrustCertChainNotifier(void *cb, TrustCertChainChangeCB */ void OCRemoveTrustCertChainNotifier(void); -/* +/** * Function to read Trust certificate chain from SVR. * Caller must free when done using the returned trust certificate * @param[in] credId CredId of trust certificate chain in SVR. diff --git a/resource/csdk/security/provisioning/include/oxm/oxmjustworks.h b/resource/csdk/security/provisioning/include/oxm/oxmjustworks.h index f2fc932..a2b846a 100644 --- a/resource/csdk/security/provisioning/include/oxm/oxmjustworks.h +++ b/resource/csdk/security/provisioning/include/oxm/oxmjustworks.h @@ -36,7 +36,7 @@ extern "C" { /** * In case of just works OxM, no need to implement. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult LoadSecretJustWorksCallback(OTMContext_t* UNUSED_PARAM); @@ -45,7 +45,7 @@ OCStackResult LoadSecretJustWorksCallback(OTMContext_t* UNUSED_PARAM); * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateSecureSessionJustWorksCallback(OTMContext_t* otmCtx); @@ -57,7 +57,7 @@ OCStackResult CreateSecureSessionJustWorksCallback(OTMContext_t* otmCtx); * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateJustWorksSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -70,7 +70,7 @@ OCStackResult CreateJustWorksSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cb * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateJustWorksOwnerTransferPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -83,7 +83,7 @@ OCStackResult CreateJustWorksOwnerTransferPayload(OTMContext_t *otmCtx, uint8_t * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateMVJustWorksSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); diff --git a/resource/csdk/security/provisioning/include/oxm/oxmmanufacturercert.h b/resource/csdk/security/provisioning/include/oxm/oxmmanufacturercert.h index cff6467..999f52d 100644 --- a/resource/csdk/security/provisioning/include/oxm/oxmmanufacturercert.h +++ b/resource/csdk/security/provisioning/include/oxm/oxmmanufacturercert.h @@ -35,7 +35,7 @@ extern "C" { * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult PrepareMCertificateCallback(OTMContext_t *otmCtx); @@ -44,7 +44,7 @@ OCStackResult PrepareMCertificateCallback(OTMContext_t *otmCtx); * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateSecureSessionMCertificateCallback(OTMContext_t *otmCtx); @@ -56,7 +56,7 @@ OCStackResult CreateSecureSessionMCertificateCallback(OTMContext_t *otmCtx); * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateMCertificateBasedSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -69,7 +69,7 @@ OCStackResult CreateMCertificateBasedSelectOxmPayload(OTMContext_t *otmCtx, uint * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateConMCertificateBasedSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -78,11 +78,11 @@ OCStackResult CreateConMCertificateBasedSelectOxmPayload(OTMContext_t *otmCtx, u * Generate payload for owner transfer request. * * @param otmCtx Context of OTM, It includes current device information. - * @param cborPaylaod is the DOXM CBOR payload including the owner information. + * @param cborPayload is the DOXM CBOR payload including the owner information. * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateMCertificateBasedOwnerTransferPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); diff --git a/resource/csdk/security/provisioning/include/oxm/oxmpreconfpin.h b/resource/csdk/security/provisioning/include/oxm/oxmpreconfpin.h index ec4ca76..c31fc1d 100644 --- a/resource/csdk/security/provisioning/include/oxm/oxmpreconfpin.h +++ b/resource/csdk/security/provisioning/include/oxm/oxmpreconfpin.h @@ -36,7 +36,7 @@ extern "C" { * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult LoadPreconfigPinCodeCallback(OTMContext_t *otmCtx); @@ -45,7 +45,7 @@ OCStackResult LoadPreconfigPinCodeCallback(OTMContext_t *otmCtx); * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateSecureSessionPreconfigPinCallback(OTMContext_t *otmCtx); @@ -53,11 +53,11 @@ OCStackResult CreateSecureSessionPreconfigPinCallback(OTMContext_t *otmCtx); * Generate payload for select OxM request. * * @param otmCtx Context of OTM, It includes current device information. - * @param cborPaylaod is the DOXM CBOR payload including the selected OxM. + * @param cborPayload is the DOXM CBOR payload including the selected OxM. * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreatePreconfigPinBasedSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -66,11 +66,11 @@ OCStackResult CreatePreconfigPinBasedSelectOxmPayload(OTMContext_t *otmCtx, uint * Generate payload for owner transfer request. * * @param otmCtx Context of OTM, It includes current device information. - * @param cborPaylaod is the DOXM CBOR payload including the owner information. + * @param cborPayload is the DOXM CBOR payload including the owner information. * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreatePreconfigPinBasedOwnerTransferPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); diff --git a/resource/csdk/security/provisioning/include/oxm/oxmrandompin.h b/resource/csdk/security/provisioning/include/oxm/oxmrandompin.h index ae7b110..998180e 100644 --- a/resource/csdk/security/provisioning/include/oxm/oxmrandompin.h +++ b/resource/csdk/security/provisioning/include/oxm/oxmrandompin.h @@ -36,7 +36,7 @@ extern "C" { * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult InputPinCodeCallback(OTMContext_t *otmCtx); @@ -45,7 +45,7 @@ OCStackResult InputPinCodeCallback(OTMContext_t *otmCtx); * * @param otmCtx Context of OTM, It includes current device information. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreateSecureSessionRandomPinCallback(OTMContext_t *otmCtx); @@ -53,11 +53,11 @@ OCStackResult CreateSecureSessionRandomPinCallback(OTMContext_t *otmCtx); * Generate payload for select OxM request. * * @param otmCtx Context of OTM, It includes current device information. - * @param cborPaylaod is the DOXM CBOR payload including the selected OxM. + * @param cborPayload is the DOXM CBOR payload including the selected OxM. * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreatePinBasedSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); @@ -66,11 +66,11 @@ OCStackResult CreatePinBasedSelectOxmPayload(OTMContext_t *otmCtx, uint8_t **cbo * Generate payload for owner transfer request. * * @param otmCtx Context of OTM, It includes current device information. - * @param cborPaylaod is the DOXM CBOR payload including the owner information. + * @param cborPayload is the DOXM CBOR payload including the owner information. * @note Returned memory should be deallocated by caller. * @param cborSize is the size of the cborPayload. * - * @return ::OC_STACK_SUCCESS in case of success and other value otherwise. + * @return ::OC_STACK_OK in case of success and other value otherwise. */ OCStackResult CreatePinBasedOwnerTransferPayload(OTMContext_t *otmCtx, uint8_t **cborPayload, size_t *cborSize); diff --git a/resource/csdk/security/provisioning/include/pmtypes.h b/resource/csdk/security/provisioning/include/pmtypes.h index 8e39a46..8581cc0 100644 --- a/resource/csdk/security/provisioning/include/pmtypes.h +++ b/resource/csdk/security/provisioning/include/pmtypes.h @@ -49,7 +49,7 @@ struct OCUuidList OCUuidList_t *next; }; -/* +/** * Device's power on/off state. */ typedef enum { @@ -128,10 +128,10 @@ typedef enum OxmAllowTableIdx { /** * Callback function definition of provisioning API * - * @param[OUT] ctx - If user set his/her context, it will be returned here. - * @param[OUT] nOfRes - total number of results, it depends on using which provisioning API. - * @param[OUT] arr - Array of OCPMResult_t, each OCPMResult_t contains result for target Device. - * @param[OUT} hasError - If there is no error, it's returned with 'false' but if there is a single + * @param[in] ctx - If user set his/her context, it will be returned here. + * @param[in] nOfRes - total number of results, it depends on using which provisioning API. + * @param[in] arr - Array of OCPMResult_t, each OCPMResult_t contains result for target Device. + * @param[in] hasError - If there is no error, it's returned with 'false' but if there is a single * or more error is/are occured during operation, it will be 'true'. */ typedef void (*OCProvisionResultCB)(void* ctx, size_t nOfRes, OCProvisionResult_t *arr, bool hasError); @@ -140,9 +140,9 @@ typedef void (*OCProvisionResultCB)(void* ctx, size_t nOfRes, OCProvisionResult_ /** * Callback function definition of direct-pairing * - * @param[OUT] ctx - User context which will be returned wth callback - * @param[OUT] peer - pairing device info. - * @param[OUT} result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK' + * @param[in] ctx - User context which will be returned wth callback + * @param[in] peer - pairing device info. + * @param[in] result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK' * if D2D pairing is success without error */ typedef void (*OCDirectPairingResultCB)(void *ctx, OCDirectPairingDev_t *peer, OCStackResult result); diff --git a/resource/csdk/security/provisioning/include/pmutility.h b/resource/csdk/security/provisioning/include/pmutility.h index 640175c..3c3ddd5 100644 --- a/resource/csdk/security/provisioning/include/pmutility.h +++ b/resource/csdk/security/provisioning/include/pmutility.h @@ -74,7 +74,7 @@ OCStackResult PMSingleDeviceDiscoveryInUnicast(unsigned short waittime, const Oi OCProvisionDev_t **ppFoundDevice); /** - * Discover owned/unowned devices in the same IP subnet. . + * Discover owned/unowned devices in the same IP subnet. * * @param[in] waittime Timeout in seconds. * @param[in] isOwned bool flag for owned / unowned discovery @@ -155,7 +155,7 @@ OCProvisionDev_t* PMCloneOCProvisionDev(const OCProvisionDev_t* src); /** * Function to generate qurey for coap/coaps request. * - * @param[in] isSeucre Choose whether to encrypt the payload. + * @param[in] isSecure Choose whether to encrypt the payload. * @param[in] address Network address of remote device * @param[in] port Port number * @param[in] connType Connectivity type of remote device diff --git a/resource/docs/c-doc/Doxyfile b/resource/docs/c-doc/Doxyfile index f97521c..011038f 100644 --- a/resource/docs/c-doc/Doxyfile +++ b/resource/docs/c-doc/Doxyfile @@ -683,11 +683,8 @@ INPUT = . \ ../../csdk/connectivity/api \ guides \ ../../csdk/security/include \ - ../../csdk/security/include\internal \ + ../../csdk/security/include/internal \ ../../csdk/security/provisioning/include \ - ../../csdk/security/provisioning/include/ocprovisioningmanager.h \ - ../../csdk/security/provisioning/include/pmtypes.h \ - ../../csdk/security/provisioning/include/pmutility.h \ ../../csdk/security/provisioning/include/internal \ ../../csdk/security/provisioning/include/oxm \ ../../csdk/security/provisioning/include/cloud \ diff --git a/resource/include/OCProvisioningManager.hpp b/resource/include/OCProvisioningManager.hpp index 730057b..5cc8279 100644 --- a/resource/include/OCProvisioningManager.hpp +++ b/resource/include/OCProvisioningManager.hpp @@ -271,14 +271,10 @@ namespace OC * @deprecated Use registerInputPinCallback instead. * - * @param InputPinCallback inputPin callback function. + * @param inputPin inputPin callback function. * @return OC_STACK_OK in case of success and other value otherwise. * OC_STACK_INVALID_CALLBACK if inputPin is invalid. * OC_STACK_DUPLICATE_REQUEST if an input pin callback has already been set. - - - - */ static OCStackResult setInputPinCallback(InputPinCallback inputPin); @@ -445,7 +441,7 @@ namespace OC */ static OCStackResult deregisterUserConfirmCallback(); - /* + /** * Set option for Mutual Verified Just-Works * The default is both display PIN and get user confirmation. */ @@ -671,7 +667,7 @@ namespace OC /** * API to get the information of device for provisioning. - * @return @ref OCProvisionDev_t Reference provides information of device for provisioning. + * @return OCProvisionDev_t Reference provides information of device for provisioning. */ OCProvisionDev_t* getDevPtr()const; -- 2.7.4