Use `URI` all caps in documentation 59/24559/2
authorGeorge Nash <george.nash@intel.com>
Tue, 3 Apr 2018 19:00:18 +0000 (12:00 -0700)
committerRick Bell <richard.s.bell@intel.com>
Mon, 9 Apr 2018 18:18:42 +0000 (18:18 +0000)
URI is all caps when used in documentation

Fixed instances where param document parameters
[in], [out] and [in,out] were used incorrectly.

A few other minor documentation issues cleaned up.

Change-Id: Ic9db0c22a667d371fd1ca00c60b5bbceba6a3c77
Signed-off-by: George Nash <george.nash@intel.com>
72 files changed:
bridging/include/ConcurrentIotivityUtils.h
bridging/plugins/hue_plugin/hue_objects/hue_light.h
bridging/plugins/lifx_plugin/lifxResource.cpp
bridging/plugins/lyric_plugin/honeywellResource.cpp
bridging/plugins/nest_plugin/nestResource.cpp
examples/OICMiddle/Client.cpp
resource/c_common/ocrandom/include/experimental/ocrandom.h
resource/csdk/connectivity/api/cainterface.h
resource/csdk/connectivity/common/inc/ulinklist.h
resource/csdk/connectivity/inc/caadapterinterface.h
resource/csdk/connectivity/inc/caadapterutils.h
resource/csdk/connectivity/inc/cablockwisetransfer.h
resource/csdk/connectivity/inc/caedradapter_singlethread.h
resource/csdk/connectivity/inc/caedrinterface.h
resource/csdk/connectivity/inc/cainterfacecontroller_singlethread.h
resource/csdk/connectivity/inc/caipadapter.h
resource/csdk/connectivity/inc/camessagehandler.h
resource/csdk/connectivity/inc/caprotocolmessage.h
resource/csdk/connectivity/inc/caraadapter.h
resource/csdk/connectivity/inc/catcpadapter.h
resource/csdk/connectivity/inc/catcpinterface.h
resource/csdk/connectivity/src/bt_edr_adapter/tizen/caedrdevicelist.h
resource/csdk/connectivity/src/bt_le_adapter/tizen/calenwmonitor.c
resource/csdk/connectivity/src/caprotocolmessage.c
resource/csdk/connectivity/src/caretransmission.c
resource/csdk/connectivity/src/ip_adapter/windows/caipnwmonitor.c
resource/csdk/connectivity/src/tcp_adapter/catcpserver.c
resource/csdk/connectivity/util/src/camanager/camanagerutil.h
resource/csdk/include/octypes.h
resource/csdk/security/include/internal/secureresourcemanager.h
resource/csdk/security/include/occertutility.h
resource/csdk/security/include/srmutility.h
resource/csdk/security/provisioning/include/cloud/occloudprovisioning.h
resource/csdk/security/provisioning/include/pmtypes.h
resource/csdk/security/provisioning/sample/cloud/cloudResource.h
resource/csdk/security/provisioning/src/multipleownershiptransfermanager.c
resource/csdk/security/provisioning/src/ownershiptransfermanager.c
resource/csdk/security/src/secureresourcemanager.c
resource/csdk/security/src/srmutility.c
resource/csdk/stack/include/internal/occlientcb.h
resource/csdk/stack/include/internal/occollection.h
resource/csdk/stack/include/ocpayload.h
resource/csdk/stack/include/ocstack.h
resource/csdk/stack/samples/linux/SimpleClientServer/occlientbasicops.h
resource/csdk/stack/src/occlientcb.c
resource/csdk/stack/src/occonnectionmanager.c
resource/csdk/stack/src/ocstack.c
resource/csdk/stack/src/oickeepalive.c
resource/examples/ocf_light/BinarySwitchResource.h
resource/examples/ocf_light/DimmingResource.h
resource/include/OCPlatform.h
resource/include/OCPlatform_impl.h
resource/include/OCResource.h
resource/include/OCResourceRequest.h
resource/include/OCResourceResponse.h
resource/include/OCUtilities.h
service/coap-http-proxy/src/CoapHttpHandler.c
service/coap-http-proxy/src/CoapHttpParser.c
service/notification/cpp-wrapper/consumer/inc/NSConsumerService.h
service/notification/cpp-wrapper/provider/inc/NSProviderService.h
service/notification/include/NSConsumerInterface.h
service/notification/include/NSProviderInterface.h
service/resource-container/bundle-api/include/NotificationReceiver.h
service/resource-container/include/RCSResourceContainer.h
service/resource-encapsulation/include/RCSDiscoveryManager.h
service/resource-encapsulation/include/RCSRemoteResourceObject.h
service/resource-encapsulation/include/RCSRepresentation.h
service/resource-encapsulation/include/RCSResourceObject.h
service/resource-encapsulation/src/resourceClient/RCSDiscoveryManagerImpl.h
service/scene-manager/src/SceneCommons.h
service/simulator/ramlparser/raml/model/RamlResource.h
service/simulator/src/server/simulator_resource_factory.h

index c55927f..db04154 100644 (file)
@@ -123,24 +123,24 @@ namespace OC
                 void stopWorkerThreads();
 
                 /**
-                 * Gets the string uri associated with an Iotivity handle.
+                 * Gets the string URI associated with an Iotivity handle.
                  * @warning This function is not thread safe and should only be called from entityHandler
                  *          specified when creating the resource. The entityhandler is called with the
                  *          Iotivity access mutex locked and this function does not modify anything
                  *          in the stack.
                  *
                  * @param[in]  handle    handle for the resource
-                 * @param[out] uri       uri associated with the handle
+                 * @param[out] uri       URI associated with the handle
                  *
-                 * @return true if the resource is found and uri will be populated, else false.
+                 * @return true if the resource is found and URI will be populated, else false.
                  */
                 bool static getUriFromHandle(OCResourceHandle handle, std::string &uri);
 
                 /**
-                 * Sends out OBSERVE notifications for the resource with the given uri.
+                 * Sends out OBSERVE notifications for the resource with the given URI.
                  * Notifications are sent out using OC_NA_QOS.
                  *
-                 * @param[in] resourceUri      resource uri for fetching handle and notifying
+                 * @param[in] resourceUri      resource URI for fetching handle and notifying
                  *
                  * @return OCStackResult OC_STACK_OK on success, some other value upon failure.
                  */
@@ -165,7 +165,7 @@ namespace OC
                                uint8_t resourceProperties);
 
                 /**
-                 * Delete the Iotivity resource given in the uri.
+                 * Delete the Iotivity resource given in the URI.
                  *
                  * @param[in] uri
                  *
index 78c451d..900632b 100644 (file)
@@ -113,7 +113,7 @@ class HueLight
         /**
          * Constructor initializes a light instance
          *
-         * @param[in] uri        is the uri for the light instance (e.g. <ip>/api/<user>/light/1)
+         * @param[in] uri        is the URI for the light instance (e.g. <ip>/api/<user>/light/1)
          * @param[in] json       is the initial JSON state for the  light. If empty,
          *                       the constructor will attempt to get the state directly
          *                       from the light.
index bd0caef..e57a9e5 100644 (file)
@@ -236,7 +236,7 @@ MPMResult createPayloadForMetadata(MPMResourceList **list, const std::string &ur
  * Creates 2 OCF resources for a LifxLight. One for the switch to turn it on and off
  * and one for brightness.
  *
- * @param[in] uri Base uri. Switch and brightness uris are baseUri appended with "/switch" & "/brightness"
+ * @param[in] uri Base URI. Switch and brightness URIs are baseUri appended with "/switch" & "/brightness"
  * @return MPM_RESULT_OK
  */
 MPMResult createOCFResources(const std::string &uri)
index 976da8d..a13cd3c 100644 (file)
@@ -296,7 +296,7 @@ MPMResult pluginDestroy(MPMPluginCtx *pluginSpecificCtx)
  * POST. Sensors resources end with /current. Actuators have uris ending with
  * /heater or /cooler.
  *
- * @param[in] uri           Resource Uri
+ * @param[in] uri           Resource URI
  * @param[in] operation     Operation to be checked.
  */
 OCEntityHandlerResult checkIfOperationIsAllowed(std::string uri, OCMethod operation)
@@ -331,7 +331,7 @@ OCEntityHandlerResult checkIfOperationIsAllowed(std::string uri, OCMethod operat
 /**
  * This method creates payload for response to GET/PUT/POST request.
  *
- * @param[in] uri           Resource Uri
+ * @param[in] uri           Resource URI
  * @param[in] data          Thermostat detials to be sent in response.
  */
 OCRepPayload *getPayload(const std::string uri, const THERMOSTAT &data)
index 4bb1335..b9e955a 100644 (file)
@@ -374,7 +374,7 @@ MPMResult pluginScan(MPMPluginCtx *, MPMPipeMessage *)
 /**
  * Creates 1 OCF resource for a NestThermostat for temperature control.
  *
- * @param[in] uri            Base uri. Resource uri is the same as base uri
+ * @param[in] uri            Base URI. Resource URI is the same as base URI
  *
  * @return MPM_RESULT_OK
  */
@@ -433,7 +433,7 @@ void updateMPMPluginSpecificData(NestThermostat::THERMOSTAT thermostat,
  * For adding a new thermostat
  *
  * @param[in] message            The add request message coming from client. It contains
- *                               the uri of the device to be added
+ *                               the URI of the device to be added
  *
  * @return MPM_RESULT_OK if no error, specific error code defined in mpmErrorCode.h
  * upon error
@@ -504,7 +504,7 @@ MPMResult pluginAdd(MPMPluginCtx *, MPMPipeMessage *message)
  * For removing a thermostat
  *
  * @param[in] message            The remove request message coming from client. It contains
- *                               the uri of the device to be removed
+ *                               the URI of the device to be removed
  *
  * @return MPM_RESULT_OK if no error, MPM_RESULT_INTERNAL_ERROR if error
  */
index 6acab49..ac467c9 100644 (file)
@@ -62,7 +62,7 @@ void MiddleClient::foundOCResource(shared_ptr<OCResource> resource)
 }
 
 /*
- *  I need a unique ID, so I concatenate the host string and resource uri
+ *  I need a unique ID, so I concatenate the host string and resource URI
  *  It's arbitrary and sufficient.
  */
 string MiddleClient::formatResourceID(std::shared_ptr<OCResource> resource)
index a5e537a..4aef970 100644 (file)
@@ -110,7 +110,7 @@ bool OCConvertStringToUuid(const char uuidString[UUID_STRING_SIZE],
  * 2. Hyphens are expected at positions {9, 14, 19, 24}.
  * 3. The rest charcters should be simple xdigits.
  *
- * @param[in] uuid    uuid extracted from uri
+ * @param[in] uuid    uuid extracted from URI
  *
  * @retval true for success, otherwise false and an error is logged
  */
index ecc24d1..1dd7039 100644 (file)
@@ -242,9 +242,9 @@ CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo);
 #endif
 
 /**
- * This function sets uri being used for proxy.
+ * This function sets URI being used for proxy.
  *
- * @param uri            NULL terminated resource uri for CoAP-HTTP Proxy.
+ * @param uri            NULL terminated resource URI for CoAP-HTTP Proxy.
  *
  * @return  ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM
  */
index 6b01883..6f184ea 100644 (file)
@@ -73,7 +73,7 @@ CAResult_t u_linklist_free(u_linklist_t **list);
 
 /**
  * Add data to the head of the link list.
- * @param[in/out]  list      pointer of link list.
+ * @param[in,out]  list      pointer of link list.
  * @param[in]      data      pointer of data.
  * @return ::CA_STATUS_OK if Success, ::CA_MEMORY_ALLOC_FAILED if memory allocation fails.
  */
@@ -81,7 +81,7 @@ CAResult_t u_linklist_add_head(u_linklist_t *list, void *data);
 
 /**
  * Add data to the tail of the link list.
- * @param[in/out]  list      pointer of link list.
+ * @param[in,out]  list      pointer of link list.
  * @param[in]      data      pointer of data.
  * @return ::CA_STATUS_OK if Success, ::CA_MEMORY_ALLOC_FAILED if memory allocation fails.
  */
@@ -91,8 +91,8 @@ CAResult_t u_linklist_add(u_linklist_t *list, void *data);
 /**
  * This api deletes node pointed by iterator.
  * Advances iterator to next node in the list.
- * @param[in/out]   list         pointer of link list.
- * @param[in/out]   iter         pointer of iterator pointing to previous node.
+ * @param[in,out]   list         pointer of link list.
+ * @param[in,out]   iter         pointer of iterator pointing to previous node.
  * @return ::CA_STATUS_OK if Success, ::CA_STATUS_INVALID_PARAM if iterator is NULL.
  */
 CAResult_t u_linklist_remove(u_linklist_t *list, u_linklist_iterator_t **iter);
index 489c31b..51a9e4d 100644 (file)
@@ -84,11 +84,12 @@ typedef CAResult_t (*CAAdapterStartDiscoveryServer)(void);
 /**
  * Sends data to the endpoint using the adapter connectivity.
  * Note: length must be > 0.
- * @param[in]   endpoint        Remote Endpoint information (like ipaddress , port,
- * reference uri and connectivity type) to which the unicast data has to be sent.
- * @param[in]   data            Data which required to be sent.
- * @param[in]   dataLen         Size of data to be sent.
- * @param[in]   dataType        Data type which is REQUEST or RESPONSE.
+ * @param[in]   endpoint  Remote Endpoint information (like ipaddress , port,
+ *                        reference URI and connectivity type) to which the
+ *                        unicast data has to be sent.
+ * @param[in]   data      Data which required to be sent.
+ * @param[in]   dataLen   Size of data to be sent.
+ * @param[in]   dataType  Data type which is REQUEST or RESPONSE.
  * @return The number of bytes sent on the network. Return value equal to -1 indicates error.
  */
 typedef int32_t (*CAAdapterSendUnicastData)(const CAEndpoint_t *endpoint,
index 3f476d3..e14e60b 100644 (file)
@@ -154,7 +154,7 @@ int CAGetSocketFdForUnicastServer(const u_arraylist_t *serverInfoList,
 /**
  * Used to add the server information into serverinfo list.
  *
- * @param[in/out]   serverInfoList    server information list.
+ * @param[in,out]   serverInfoList    server information list.
  * @param[in]       info              server informations like ip, port.
  *
  * @return ::CA_STATUS_OK or Appropriate error code.
@@ -167,7 +167,7 @@ CAResult_t CAAddServerInfo(u_arraylist_t *serverInfoList, CAServerInfo_t *info);
 /**
  * Used to remove the server information based on socket fd from server info list.
  *
- * @param[in/out]   serverInfoList    server information list.
+ * @param[in,out]   serverInfoList    server information list.
  * @param[in]       sockFd            Socket descriptor.
  */
 void CARemoveServerInfo(u_arraylist_t *serverInfoList, int sockFd);
index c242f29..b37f0a5 100644 (file)
@@ -294,7 +294,7 @@ CAResult_t CAUpdateMessageId(coap_pdu_t *pdu, const CABlockDataID_t *blockID);
  * Update the block option items.
  * @param[in]   currData    stored block data information.
  * @param[in]   pdu received pdu binary data.
- * @param[in/out]   block   block option of current message.
+ * @param[in,out]   block   block option of current message.
  * @param[in]   blockType  block option type.
  * @param[in]   status  current flow status for block-wise transfer.
  * @return ::CASTATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
@@ -362,7 +362,7 @@ CAResult_t CAAddOptionToPDU(coap_pdu_t *pdu, coap_list_t **options);
 
 /**
  * Add the size option in pdu data.
- * @param[in/out]   pdu    pdu object.
+ * @param[in,out]   pdu    pdu object.
  * @param[in]   sizeType    size option type.
  * @param[in]   dataLength the total payload length to be sent.
  * @return ::CASTATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
@@ -403,7 +403,7 @@ CAData_t* CACreateNewDataSet(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint
 
 /**
  * Update the block option items.
- * @param[in/out]   blockblock option of current message.
+ * @param[in,out]   blockblock option of current message.
  * @param[in]   blockType   block option type.
  * @param[in]   responseResult  result code of pdu.
  * @return ::CASTATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
@@ -413,7 +413,7 @@ CAResult_t CAHandleBlockErrorResponse(coap_block_t *block, uint16_t blockType,
 
 /**
  * Check the received payload and if an error happens, return error type.
- * @param[in/out]   currData    stored block data information.
+ * @param[in,out]   currData    stored block data information.
  * @param[in]   receivedBlock   received block option.
  * @param[in]   receivedData    message type of pdu.
  * @param[in]   blockType   block option type.
index af337fe..dda66e8 100644 (file)
@@ -40,12 +40,12 @@ extern "C"
 
 /**
  * @brief  Initialize EDR Interface.
- * @param  registerCallback  [IN] Callback to register EDR interface to Connectivity
- *                                Abstraction Layer
- * @param  reqRespCallback   [IN] Callback to notify request and response messages from server(s)
- *                                started at Connectivity Abstraction Layer.
- * @param  netCallback       [IN] Callback to notify the network additions to Connectivity
- *                                Abstraction Layer.
+ * @param[in] registerCallback  Callback to register EDR interface to Connectivity
+ *                              Abstraction Layer
+ * @param[in] reqRespCallback   Callback to notify request and response messages from server(s)
+ *                              started at Connectivity Abstraction Layer.
+ * @param[in] netCallback       Callback to notify the network additions to Connectivity
+ *                              Abstraction Layer.
  * @return #CA_STATUS_OK or Appropriate error code
  * @retval #CA_STATUS_OK Successful
  * @retval #CA_STATUS_INVALID_PARAM Invalid input parameters
@@ -98,10 +98,10 @@ CAResult_t CAStartEDRDiscoveryServer(void);
 
 /**
  * @brief  Sends data to the peer bluetooth OIC device using the adapter connectivity.
- * @param  endpoint        [IN] Remote Endpoint information (like ipaddress, port, reference uri and
- *                              connectivity type) to which the unicast data has to be sent.
- * @param  data            [IN] Data to be sent.
- * @param  dataLength      [IN] Size of data to be sent.
+ * @param[in]  endpoint    Remote Endpoint information (like ipaddress, port, reference URI and
+ *                         connectivity type) to which the unicast data has to be sent.
+ * @param[in]  data        Data to be sent.
+ * @param[in]  dataLength  Size of data to be sent.
  * @return Number of bytes sent on the network. Returns -1 on error.
  */
 int32_t CASendEDRUnicastData(const CAEndpoint_t *remoteEndpoint, const void *data,
@@ -110,8 +110,8 @@ int32_t CASendEDRUnicastData(const CAEndpoint_t *remoteEndpoint, const void *dat
 /**
  * @brief  Sends multicast data to all discovered bluetooth OIC devices using the adapter
  *         connectivity.
- * @param  data         [IN]  Data which needs to be sent to all discovered bluetooth OIC device.
- * @param  dataLength   [IN]  Length of data in bytes.
+ * @param[in]  data        Data which needs to be sent to all discovered bluetooth OIC device.
+ * @param[in]  dataLength  Length of data in bytes.
  * @return Number of bytes sent on the network. Returns -1 on error.
  */
 int32_t CASendEDRMulticastData(const void *data, uint32_t dataLength);
@@ -119,8 +119,8 @@ int32_t CASendEDRMulticastData(const void *data, uint32_t dataLength);
 /**
  * @brief  Get EDR Connectivity network information.
  *
- * @param  info [OUT] Array of local connectivity information structures.
- * @param  size [OUT] Size of the array @info.
+ * @param[out] info  Array of local connectivity information structures.
+ * @param[out] size  Size of the array @info.
  *
  * @return #CA_STATUS_OK or Appropriate error code
  * @retval #CA_STATUS_OK  Successful
index 92de500..eaf24dd 100644 (file)
@@ -103,7 +103,7 @@ typedef void (*CAEDRNetworkStatusCallback)(CANetworkStatus_t status);
 /**
  * Callback to notify the error in the EDR adapter.
  * @param[in]  remoteAddress   Remote EDR Address.
- * @param[in]  data            data containing token, uri and coap data.
+ * @param[in]  data            data containing token, URI and coap data.
  * @param[in]  dataLength      length of data.
  * @param[in]  result          error code as defined in ::CAResult_t.
  * @pre Callback must be registered using CAEDRSetPacketReceivedCallback().
index d360c8c..ee15f5b 100644 (file)
@@ -36,45 +36,45 @@ extern "C"
 
 /**
  * @brief   Initializes different adapters based on the compilation flags.
- * @param   handle          [IN]    thread pool handle created by message handler for different
- *                                  adapters.
+ * @param[in] handle  thread pool handle created by message handler for different
+ *                    adapters.
  * @return   none
  */
 void CAInitializeAdapters();
 
 /**
  * @brief   Set the received packets callback for message handler
- * @param   callback        [IN]    message handler callback to receive packets from different
- *                                  adapters.
+ * @param[in] callback  message handler callback to receive packets from different
+ *                      adapters.
  * @return   none
  */
 void CASetPacketReceivedCallback(CANetworkPacketReceivedCallback callback);
 
 /**
  * @brief   Set the adapter status changed callback for message handler
- * @param   callback        [IN]    message handler network status callback to receive network
- *                                  changes.
+ * @param[in] callback  message handler network status callback to receive network
+ *                      changes.
  * @return   none
  */
 void CASetNetworkChangeCallback(CAAdapterChangeCallback callback);
 
 /**
  * @brief   Set the error handler callback for message handler
- * @param   errorCallback       [IN]    error handler callback from adapters
+ * @param[in] errorCallback  error handler callback from adapters
  * @return  none
  */
 void CASetErrorHandleCallback(CAErrorHandleCallback errorCallback);
 
 /**
  * @brief   Starting different connectivity adapters based on the network selection.
- * @param   transportAdapter [IN]    network type that want to stop
+ * @param[in] transportAdapter network type that want to stop
  * @return  none
  */
 CAResult_t CAStartAdapter(CATransportAdapter_t transportType);
 
 /**
  * @brief   Stopping different connectivity adapters based on the network un-selection.
- * @param   transportAdapter [IN]    un selected network for stopping the packets transfer
+ * @param[in] transportAdapter  un selected network for stopping the packets transfer
  * @return   none
  */
 void CAStopAdapter(CATransportAdapter_t transportType);
@@ -82,26 +82,26 @@ void CAStopAdapter(CATransportAdapter_t transportType);
 /**
  * @brief   Get network information such as ipaddress and mac information.  Gets the network
  *          information of the adapter whichever is enabled. Otherwise info is NULL.
- * @param   info            [OUT]    connectivity information such as ipaddress and mac information
- * @param   size            [OUT]    number of connectivity information structures
+ * @param[out] info  connectivity information such as ipaddress and mac information
+ * @param[out] size  number of connectivity information structures
  * @return   CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  */
 CAResult_t CAGetNetworkInfo(CAEndpoint_t **info, uint32_t *size);
 
 /**
  * @brief   Sends unicast data to the remote endpoint
- * @param   endpoint        [IN]    endpoint information where the data has to be sent
- * @param   data            [IN]    data that needs to be sent
- * @param   length          [IN]    length of the data that needs to be sent
+ * @param[in] endpoint  endpoint information where the data has to be sent
+ * @param[in] data      data that needs to be sent
+ * @param[in] length    length of the data that needs to be sent
  * @return   CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  */
 CAResult_t CASendUnicastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
 
 /**
  * @brief   Sends multicast data to all endpoints in the network.
- * @param   endpoint        [IN]    endpoint information where the data has to be sent
- * @param   data            [IN]    data that needs to be sent
- * @param   length          [IN]    length of the data that needs to be sent
+ * @param[in] endpoint  endpoint information where the data has to be sent
+ * @param[in] data      data that needs to be sent
+ * @param[in] length    length of the data that needs to be sent
  * @return   CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  */
 CAResult_t CASendMulticastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
index 93e38ba..c05d11d 100644 (file)
@@ -88,7 +88,7 @@ CAResult_t CAStartIPDiscoveryServer(void);
 /**
  * Sends data to the endpoint using the adapter connectivity.
  * @param[in]   endpoint       Remote Endpoint information (like ipaddress,
- *                              port, reference uri and transport type) to
+ *                              port, reference URI and transport type) to
  *                              which the unicast data has to be sent.
  * @param[in]   data           Data which is required to be sent.
  * @param[in]   dataLen        Size of data to be sent.
index c04e9ce..dd08737 100644 (file)
@@ -115,8 +115,8 @@ void CAAddDataToReceiveThread(CAData_t *data);
 #ifdef TCP_ADAPTER
 /**
  * Add a header option to the given header option array.
- * @param[in/out] hdrOpt            Pointer to existing options.
- * @param[in/out] numOptions        Number of existing options.
+ * @param[in,out] hdrOpt            Pointer to existing options.
+ * @param[in,out] numOptions        Number of existing options.
  * @param[in]     optionID          COAP option ID.
  * @param[in]     optionData        Option data value.
  * @param[in]     optionDataLength  Size of Option data value.
index 4991b4c..dcca086 100644 (file)
@@ -111,7 +111,7 @@ coap_pdu_t *CAGeneratePDUImpl(code_t code, const CAInfo_t *info,
 
 /**
  * parse the URI and creates the options.
- * @param[in]    uriInfo             uri information.
+ * @param[in]    uriInfo             URI information.
  * @param[out]   options             options information.
  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
  */
@@ -133,7 +133,7 @@ CAResult_t CAParseUriPartial(const unsigned char *str, size_t length, uint16_t t
 
 /**
  * create option list from header information in the info.
- * @param[in]   code                 uri information.
+ * @param[in]   code                 URI information.
  * @param[in]   info                 information of the request/response.
  * @param[out]  optlist              options information.
  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
index e93d813..139eaa6 100644 (file)
@@ -64,7 +64,7 @@ CAResult_t CAStartRA();
 /**
  * Sends data to the endpoint using the adapter connectivity.
  * @param[in]   endpoint    Remote Endpoint information (like ipaddress, port,
- *                           reference uri and transport type) to which
+ *                           reference URI and transport type) to which
  *                           the unicast data has to be sent.
  * @param[in]   data        Data which is required to be sent.
  * @param[in]   dataLen     Size of data to be sent.
index 8b83907..0326253 100644 (file)
@@ -153,7 +153,7 @@ CAResult_t CAStartTCPDiscoveryServer(void);
 /**
  * Sends data to the endpoint using the adapter connectivity.
  * @param[in]   endpoint       Remote Endpoint information (like ipaddress,
- *                              port, reference uri and transport type) to
+ *                              port, reference URI and transport type) to
  *                              which the unicast data has to be sent.
  * @param[in]   data           Data which is required to be sent.
  * @param[in]   dataLen        Size of data to be sent.
@@ -216,7 +216,7 @@ void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler);
 /**
  * Get Capability and Settings message(CSM) exchange state.
  * @param[in]   endpoint        Remote Endpoint information (like ipaddress,
- *                              port, reference uri and transport type)
+ *                              port, reference URI and transport type)
  *                              to check CSM state in session information.
  * @return  current CSM exchange state of the session.
  */
@@ -225,7 +225,7 @@ CACSMExchangeState_t CAGetCSMState(const CAEndpoint_t *endpoint);
 /**
 * Update Capability and Settings message(CSM) exchange state when sending or receiving CSM.
 * @param[in]   endpoint        Remote Endpoint information (like ipaddress,
-*                              port, reference uri and transport type) to update CSM state.
+*                              port, reference URI and transport type) to update CSM state.
 * @param[in]   state           CSM exchange state to be updated.
 */
 void CAUpdateCSMState(const CAEndpoint_t *endpoint, CACSMExchangeState_t state);
index 5544657..d996c47 100644 (file)
@@ -186,7 +186,7 @@ uint32_t CAGetCodeFromHeader(const unsigned char *recvBuffer);
  * Get socket file descriptor from remote device information.
  *
  * @param[in]   endpoint    Remote Endpoint information (such as ipaddress,
- *                          port, reference uri and transport type) to
+ *                          port, reference URI and transport type) to
  *                          which the unicast data has to be sent.
  * @return  Created socket file descriptor.
  */
@@ -196,7 +196,7 @@ CASocketFd_t CAGetSocketFDFromEndpoint(const CAEndpoint_t *endpoint);
  * Find the session with endpoint info and remove it from list.
  *
  * @param[in]   endpoint    Remote Endpoint information (such as ipaddress,
- *                          port, reference uri and transport type) to
+ *                          port, reference URI and transport type) to
  *                          which the unicast data has to be sent.
  * @return  ::CA_STATUS_OK or Appropriate error code.
  */
@@ -215,8 +215,8 @@ size_t CACheckPayloadLengthFromHeader(const void *data, size_t dlen);
  * Construct CoAP header and payload from buffer
  *
  * @param[in] svritem - used socket, buffer, current received message length and protocol
- * @param[in/out]  data  - data buffer, this value is updated as data is copied to svritem
- * @param[in/out]  dataLength  - length of data, this value decreased as data is copied to svritem
+ * @param[in,out]  data  - data buffer, this value is updated as data is copied to svritem
+ * @param[in,out]  dataLength  - length of data, this value decreased as data is copied to svritem
  * @return             - CA_STATUS_OK or appropriate error code
  */
 CAResult_t CAConstructCoAP(CATCPSessionInfo_t *svritem, unsigned char **data,
@@ -225,7 +225,7 @@ CAResult_t CAConstructCoAP(CATCPSessionInfo_t *svritem, unsigned char **data,
 /**
  * Clean socket state data
  *
- * @param[in/out] svritem - socket state data
+ * @param[in,out] svritem - socket state data
  */
 void CACleanData(CATCPSessionInfo_t *svritem);
 
index 84314a4..0590f81 100644 (file)
@@ -76,7 +76,7 @@ typedef struct _EDRDeviceList
 /**
  * Creates ::EDRDevice for specified remote address and uuid and to device list.
  *
- * @param[in/out]  deviceList       Device list which created device add to.
+ * @param[in,out]  deviceList       Device list which created device add to.
  * @param[in]      deviceAddress    Bluetooth device address.
  * @param[in]      uuid             Service uuid.
  * @param[in]      device           Created ::EDRDevice.
@@ -92,7 +92,7 @@ CAResult_t CACreateAndAddToDeviceList(EDRDeviceList **deviceList, const char *de
 /**
  * Insert device to specified list.
  *
- * @param[in/out]  deviceList        Device list to which specifed @device to be added.
+ * @param[in,out]  deviceList        Device list to which specifed @device to be added.
  * @param[in]      device            Device to be added to list.
  *
  * @return ::CA_STATUS_OK or Appropriate error code.
@@ -135,7 +135,7 @@ CAResult_t CAGetEDRDeviceBySocketId(EDRDeviceList *deviceList, int32_t socketID,
 /**
  * Remove and delete the device matching specified device address from list.
  *
- * @param[in/out]  deviceList        Device list to search for the device.
+ * @param[in,out]  deviceList        Device list to search for the device.
  * @param[in]      deviceAddress     Bluetooth device address.
  *
  * @return ::CA_STATUS_OK or Appropriate error code.
@@ -148,7 +148,7 @@ CAResult_t CARemoveEDRDeviceFromList(EDRDeviceList **deviceList,
 
 /**
  * Destroy the specified device list. Removes and delete all the devices in the list.
- * @param[in/out]  deviceList      Device list to be destroyed.
+ * @param[in,out]  deviceList      Device list to be destroyed.
  */
 void CADestroyEDRDeviceList(EDRDeviceList **deviceList);
 
@@ -168,7 +168,7 @@ CAResult_t CAAddEDRDataToList(EDRDataList **dataList, const void *data, uint32_t
 
 /**
  * Remove and delete data from front end of list.
- * @param[in/out]  dataList      Data list from which data will be removed.
+ * @param[in,out]  dataList      Data list from which data will be removed.
  *
  * @return ::CA_STATUS_OK or Appropriate error code.
  * @retval ::CA_STATUS_OK  Successful.
index 1ae3357..ed53fec 100644 (file)
@@ -68,9 +68,9 @@ static oc_mutex g_bleConnectionStateChangedCbMutex = NULL;
 /**
 * This is the callback which will be called when the adapter state gets changed.
 *
-* @param result         [IN] Result of the query done to the platform.
-* @param adapter_state  [IN] State of the LE adapter.
-* @param user_data      [IN] User data passed by the caller when querying for the state changed cb.
+* @param[in] result         Result of the query done to the platform.
+* @param[in] adapter_state  State of the LE adapter.
+* @param[in] user_data      User data passed by the caller when querying for the state changed cb.
 *
 * @return  None.
 */
@@ -80,10 +80,10 @@ void CALEAdapterStateChangedCb(int result, bt_adapter_state_e adapter_state,
 /**
 * This is the callback which will be called when the connection state gets changed.
 *
-* @param result         [IN] Result of the query done to the platform.
-* @param connected      [IN] State of connection.
-* @param remoteAddress  [IN] LE address of the device to be notified.
-* @param user_data      [IN] User data passed by the caller when querying for the state changed cb.
+* @param[in] result         Result of the query done to the platform.
+* @param[in] connected      State of connection.
+* @param[in] remoteAddress  LE address of the device to be notified.
+* @param[in] user_data      User data passed by the caller when querying for the state changed cb.
 *
 * @return  None.
 */
index df98894..42a835a 100644 (file)
@@ -1096,8 +1096,8 @@ CAResult_t CAGetInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
     else if(isProxyRequest && g_chproxyUri[0] != '\0')
     {
        /*
-        *   A request for Proxy will not have any uri element as per CoAP specs
-        *   and only COAP_OPTION_PROXY_URI will be present. Use preset proxy uri
+        *   A request for Proxy will not have any URI element as per CoAP specs
+        *   and only COAP_OPTION_PROXY_URI will be present. Use preset proxy URI
         *   for such requests.
         */
         outInfo->resourceUri = OICStrdup(g_chproxyUri);
index 3d8e2b7..c08352c 100644 (file)
@@ -136,8 +136,8 @@ CAResult_t CARetransmissionStart(CARetransmission_t *context)
 
 /**
  * @brief   check timeout routine
- * @param   currentTime     [IN]microseconds
- * @param   retData         [IN]retransmission data
+ * @param[in] currentTime  microseconds
+ * @param[in] retData      retransmission data
  * @return  true if the timeout period has elapsed, false otherwise
  */
 static bool CACheckTimeout(uint64_t currentTime, CARetransmissionData_t *retData)
index 5006d52..a89070f 100644 (file)
@@ -692,7 +692,7 @@ static bool IsValidNetworkAdapter(PIP_ADAPTER_ADDRESSES pAdapterAddr, int desire
  * Allocate a new CAInterface_t structure and add it to a given list.  A new entry is added
  * for each address.
  *
- * @param[in/out] iflist  List to add to.
+ * @param[in,out] iflist  List to add to.
  * @param[in]     name    Interface name.
  * @param[in]     index   Interface index.
  * @param[in]     family  Address family.
index bbc26e0..92e8fda 100644 (file)
@@ -364,7 +364,7 @@ static void CASelectReturned(fd_set *readFds)
  * @param[in] socketArray    Array in which to add socket
  * @param[in] event          Event to push
  * @param[in] eventArray     Array in which to add event
- * @param[in/out] eventIndex Current length of arrays
+ * @param[in,out] eventIndex Current length of arrays
  * @param[in] arraySize      Maximum length of arrays
  * @return true on success, false on failure
  */
@@ -388,7 +388,7 @@ static bool CAPushEvent(CASocketFd_t s, CASocketFd_t* socketArray,
  * @param[in] s              Socket to push
  * @param[in] socketArray    Array in which to add socket
  * @param[in] eventArray     Array in which to add event
- * @param[in/out] eventIndex Current length of arrays
+ * @param[in,out] eventIndex Current length of arrays
  * @param[in] arraySize      Maximum length of arrays
  * @return true on success, false on failure
  */
@@ -618,7 +618,7 @@ static void CAAcceptConnection(CATransportFlags_t flag, CASocket_t *sock)
 /**
  * Clean socket state data
  *
- * @param[in/out] item - socket state data
+ * @param[in,out] item - socket state data
  */
 void CACleanData(CATCPSessionInfo_t *svritem)
 {
@@ -637,8 +637,8 @@ void CACleanData(CATCPSessionInfo_t *svritem)
  * Construct CoAP header and payload from buffer
  *
  * @param[in] svritem - used socket, buffer, current received message length and protocol
- * @param[in/out]  data  - data buffer, this value is updated as data is copied to svritem
- * @param[in/out]  dataLength  - length of data, this value decreased as data is copied to svritem
+ * @param[in,out]  data  - data buffer, this value is updated as data is copied to svritem
+ * @param[in,out]  dataLength  - length of data, this value decreased as data is copied to svritem
  * @return             - CA_STATUS_OK or appropriate error code
  */
 CAResult_t CAConstructCoAP(CATCPSessionInfo_t *svritem, unsigned char **data,
index adf41cd..9e9b7f1 100644 (file)
@@ -130,7 +130,7 @@ CAResult_t CAMgrUtilResetDevInfo(CMDeviceInfoList_t *devInfoList);
 void CAMgrUtilDestroyDevInfoList(CMDeviceInfoList_t *devInfoList);
 
 /**
- *  This function is used to get a device id from uri.
+ *  This function is used to get a device id from URI.
  *
  *  @param[in] uri
  *
index d4e1d2c..45e304d 100644 (file)
@@ -1883,10 +1883,10 @@ typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
 /**
  * Callback function definition for Change in TrustCertChain
  *
- * @param[IN] ctx - user context returned in the callback.
- * @param[IN] credId - trustCertChain changed for this ID
- * @param[IN] trustCertChain - trustcertchain binary blob.
- * @param[IN] chainSize - size of trustchain
+ * @param[in] ctx - user context returned in the callback.
+ * @param[in] credId - trustCertChain changed for this ID
+ * @param[in] trustCertChain - trustcertchain binary blob.
+ * @param[in] chainSize - size of trustchain
  */
 typedef void (*TrustCertChainChangeCB)(void *ctx, uint16_t credId, uint8_t *trustCertChain,
         size_t chainSize);
index 44daaa6..3980d4b 100644 (file)
@@ -69,7 +69,7 @@ typedef struct SRMRequestContext
 /**
  * Register Persistent storage callback.
  *
- * @param  persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
+ * @param[in] persistentStorageHandler  Pointers to open, read, write, close & unlink handlers.
  *
  * @return ::OC_STACK_OK  is no errors and successful. ::OC_STACK_INVALID_PARAM for invalid parameter.
  */
@@ -118,7 +118,7 @@ typedef bool (*SPResponseCallback) (const CAEndpoint_t *object,
                                     const CAResponseInfo_t *responseInfo);
 /**
  * Get the resource type from the URI.
- * @param   uri [IN] Pointers to security resource URI.
+ * @param[in]   uri Pointers to security resource URI.
  * @return  SVR type (note that "NOT_A_SVR_RESOURCE" is returned if not a SVR)
  */
 OicSecSvrType_t GetSvrTypeFromUri(const char* uri);
index 76473a6..7042835 100644 (file)
@@ -34,10 +34,10 @@ extern "C" {
  * Callers must record used serial numbers and ensure serial numbers do not
  * get repeated!
  *
- * @param[OUT] serial      Pointer to a string that will be set to the location of the ASCII serial number.
+ * @param[out] serial      Pointer to a string that will be set to the location of the ASCII serial number.
  *                         Memory for this buffer will be allocated internally; caller must call OICFree on serial
  *                         when finished to free its memory.
- * @param[OUT] serialLen   Variable to receive size of serial, which will include the terminating NULL.
+ * @param[out] serialLen   Variable to receive size of serial, which will include the terminating NULL.
  *
  * @return OC_STACK_OK if generated successfully; error otherwise.
  */
@@ -47,14 +47,14 @@ OCStackResult OC_CALL OCGenerateRandomSerialNumber(char **serial, size_t *serial
  * Generate a new NIST P-256 elliptic curve key pair and return the public and private
  * keys as PEM encoded strings.
  *
- * @param[OUT] publicKey     Pointer to receive PEM encoded public key. Memory is allocated internally
+ * @param[out] publicKey     Pointer to receive PEM encoded public key. Memory is allocated internally
  *                           and must be freed by caller with OICFree.
- * @param[OUT] publicKeyLen  Variable to receive length of publicKey, which will include terminating NULL.
- * @param[OUT] privateKey    Pointer to receive PEM encoded private key. Memory is allocated internally
+ * @param[out] publicKeyLen  Variable to receive length of publicKey, which will include terminating NULL.
+ * @param[out] privateKey    Pointer to receive PEM encoded private key. Memory is allocated internally
  *                           and, when finished, caller should first call OICClearMemory to securely erase
  *                           its contents and then freed with OICFree. Caller is responsible for ensuring
  *                           this key remains protected and secret!
- * @param[OUT] privateKeyLen Variable to receive length of privateKey, which will include terminating NULL.
+ * @param[out] privateKeyLen Variable to receive length of privateKey, which will include terminating NULL.
  */
 OCStackResult OC_CALL OCGenerateKeyPair(char **publicKey, size_t *publicKeyLen,
                                         char **privateKey, size_t *privateKeyLen);
@@ -79,10 +79,10 @@ OCStackResult OC_CALL OCGenerateKeyPair(char **publicKey, size_t *publicKeyLen,
  *                              e.g., "20131231235959" for December 31st 2013 at 23:59:59
  * @param notValidAfter         The notValidAfter date in UTC for the certificate in the form YYYYMMDDhhmmss
  *                              e.g., "20140101010203" for January 1st 2014 at 01:02:03
- * @param[OUT] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
+ * @param[out] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
  *                              allocated internally; caller must call OICFree on certificate when finished to free
  *                              its memory.
- * @param[OUT] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
+ * @param[out] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
  *
  * @return OC_STACK_OK if successful, error code otherwise
  */
@@ -117,10 +117,10 @@ OCStackResult OC_CALL OCGenerateRootCACertificate(
  *                              e.g., "20131231235959" for December 31st 2013 at 23:59:59
  * @param notValidAfter         The notValidAfter date in UTC for the certificate in the form YYYYMMDDhhmmss
  *                              e.g., "20140101010203" for January 1st 2014 at 01:02:03
- * @param[OUT] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
+ * @param[out] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
  *                              allocated internally; caller must call OICFree on certificate when finished to free
  *                              its memory.
- * @param[OUT] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
+ * @param[out] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
  *
  * @return OC_STACK_OK if successful, error code otherwise
  */
@@ -151,10 +151,10 @@ OCStackResult OC_CALL OCGenerateIntermediateCACertificate(
  *                              e.g., "20131231235959" for December 31st 2013 at 23:59:59
  * @param notValidAfter         The notValidAfter date in UTC for the certificate in the form YYYYMMDDhhmmss
  *                              e.g., "20140101010203" for January 1st 2014 at 01:02:03
- * @param[OUT] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
+ * @param[out] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
  *                              allocated internally; caller must call OICFree on certificate when finished to free
  *                              its memory.
- * @param[OUT] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
+ * @param[out] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
  *
  * @return OC_STACK_OK if successful, error code otherwise
  */
@@ -188,10 +188,10 @@ OCStackResult OC_CALL OCGenerateIdentityCertificate(
  * @param role                  The role to encode in the certificate.
  * @param authority             The role authority to encode in the certificate. This field is optional;
  *                              to omit, use NULL, and authority is construed to be the certificate issuer.
- * @param[OUT] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
+ * @param[out] certificate      Pointer to a buffer that will receive the PEM-encoded certificate. Memory will be
  *                              allocated internally; caller must call OICFree on certificate when finished to free
  *                              its memory.
- * @param[OUT] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
+ * @param[out] certificateLen   Variable to receive the size of certificate, which will include the terminating NULL.
  *
  * @return OC_STACK_OK if successful, error code otherwise
  */
@@ -258,4 +258,4 @@ OCStackResult OC_CALL OCConvertDerCSRToPem(const char* derCSR, size_t derCSRLen,
 
 #endif /* OCCERTUTILITY_H_ */
 
-#endif /* defined(__WITH_TLS__) || defined(__WITH_DTLS__) */
\ No newline at end of file
+#endif /* defined(__WITH_TLS__) || defined(__WITH_DTLS__) */
index 61043d1..474b813 100644 (file)
@@ -175,7 +175,7 @@ OCStackResult OC_CALL ConvertStrToUuid(const char* strUuid, OicUuid_t* uuid);
  * Is the URI for a Device Configuration Resource as defined
  * by Security Specification.
  *
- * @return true IFF the uri is for a DCR
+ * @return true IFF the URI is for a DCR
  */
 bool IsDeviceConfigurationResourceUri(const char *uri);
 
@@ -183,7 +183,7 @@ bool IsDeviceConfigurationResourceUri(const char *uri);
  * Is the URI for a Non0Configuration Resource as defined
  * by Security Specification.
  *
- * @return true IFF the uri is for a NCR
+ * @return true IFF the URI is for a NCR
  */
 bool IsNonConfigurationResourceUri(const char *uri);
 
@@ -220,7 +220,7 @@ OCStackResult OC_CALL SetDeviceIdSeed(const uint8_t* seed, size_t seedSize);
  * Is the URI for a Security Virtual Resource as defined
  * by Security Specification.
  *
- * @return true IFF the uri is for a SVR
+ * @return true IFF the URI is for a SVR
  */
 bool SRMIsSecurityResourceURI(const char* uri);
 
index 91c1d84..9b4cc9c 100644 (file)
@@ -437,7 +437,7 @@ OCStackResult OCCloudAclCancelInvitation(void* ctx,
  * @param[in] subjectId         mandatory parameter subject id
  * @param[in] deviceId          mandatory parameter device id
  * @param[in] method            mandatory parameter method
- * @param[in] uri               mandatory parameter uri
+ * @param[in] uri               mandatory parameter URI
  * @param[in] cloudUri          cloud host and port
  * @param[in] callback          optional result callback, can be NULL if not required
  * @return  OCStackResult application result
index 9d0e3da..2fecdef 100644 (file)
@@ -155,13 +155,13 @@ typedef void (*OCProvisionResultCB)(void* ctx, size_t nOfRes, OCProvisionResult_
 /**
  * Callback function definition of CSR retrieve API
  *
- * @param[OUT] ctx - If user set a context, it will be returned here.
- * @param[OUT] nOfRes - total number of results
- * @param[OUT] arr - Array of OCPMGetCsrResult_t, containing one entry for each target device. If an entry's res
+ * @param[out] ctx - If user set a context, it will be returned here.
+ * @param[out] nOfRes - total number of results
+ * @param[out] arr - Array of OCPMGetCsrResult_t, containing one entry for each target device. If an entry's res
  *                   member is OC_STACK_OK, then csr and csrLen are valid; otherwise they should not be used.
  *                   This memory is only valid while the callback is executing; callers must make copies if the data
  *                   needs to be kept longer.
- * @param[OUT] hasError - If all calls succeded, this will be false. One or more errors, and this will
+ * @param[out] hasError - If all calls succeded, this will be false. One or more errors, and this will
  *                        be true. Examine the elements of arr to discover which failed.
  */
 typedef void (*OCGetCSRResultCB)(void* ctx, size_t nOfRes, OCPMGetCsrResult_t *arr, bool hasError);
@@ -169,12 +169,12 @@ typedef void (*OCGetCSRResultCB)(void* ctx, size_t nOfRes, OCPMGetCsrResult_t *a
 /**
  * Callback function definition of SP retrieve API
  *
- * @param[OUT] ctx - If user set a context, it will be returned here.
- * @param[OUT] nOfRes - total number of results
- * @param[OUT] arr - Array of OCPMGetSpResult_t, containing one entry for each target device. If an entry's res
+ * @param[out] ctx - If user set a context, it will be returned here.
+ * @param[out] nOfRes - total number of results
+ * @param[out] arr - Array of OCPMGetSpResult_t, containing one entry for each target device. If an entry's res
  *                   member is OC_STACK_OK, This memory is only valid while the callback is executing;
  *                   callers must make copies if the data needs to be kept longer.
- * @param[OUT] hasError - If all calls succeded, this will be false. One or more errors, and this will
+ * @param[out] hasError - If all calls succeded, this will be false. One or more errors, and this will
  *                        be true. Examine the elements of arr to discover which failed.
  */
 typedef void (*OCGetSpResultCB)(void* ctx, size_t nOfRes, OCPMGetSpResult_t *arr, bool hasError);
@@ -182,13 +182,13 @@ typedef void (*OCGetSpResultCB)(void* ctx, size_t nOfRes, OCPMGetSpResult_t *arr
 /**
  * Callback function definition of roles retrieve API
  *
- * @param[OUT] ctx - If user set a context, it will be returned here.
- * @param[OUT] nOfRes - total number of results
- * @param[OUT] arr - Array of OCPMGetRolesResult_t, containing one entry for each target device. If an entry's res
+ * @param[out] ctx - If user set a context, it will be returned here.
+ * @param[out] nOfRes - total number of results
+ * @param[out] arr - Array of OCPMGetRolesResult_t, containing one entry for each target device. If an entry's res
  *                   member is OC_STACK_OK, then chains and chainsLength are valid; otherwise they should not be used.
  *                   This memory is only valid while the callback is executing; callers must make copies if the data
  *                   needs to be kept longer.
- * @param[OUT] hasError - If all calls succeeded, this will be false. One or more errors, and this will
+ * @param[out] hasError - If all calls succeeded, this will be false. One or more errors, and this will
  *                        be true. Examine the elements of arr to discover which failed.
  */
 typedef void (*OCGetRolesResultCB)(void* ctx, size_t nOfRes, OCPMGetRolesResult_t *arr, bool hasError);
index 8126118..025d80c 100644 (file)
@@ -29,7 +29,7 @@ typedef struct LEDRESOURCE{
 /**
  * Creates resource with all required request handlers
  *
- * @param[in] uri          resource uri
+ * @param[in] uri          resource URI
  * @param[in] resource     resource
   * @return  OCStackResult application result
  */
index 8ab6460..1e198d7 100644 (file)
@@ -1272,8 +1272,8 @@ exit:
 /**
  * Function to handle the handshake result in MOT.
  * This function will be invoked after DTLS handshake
- * @param   endPoint  [IN] The remote endpoint.
- * @param   errorInfo [IN] Error information from the endpoint.
+ * @param[in] endPoint  The remote endpoint.
+ * @param[in] errorInfo Error information from the endpoint.
  * @return  NONE
  */
 static CAResult_t MOTDtlsHandshakeCB(const CAEndpoint_t *endpoint, const CAErrorInfo_t *info)
@@ -1320,7 +1320,7 @@ exit:
 /**
  * Function to add a device to the provisioning database via the
  * Provisioning Database Manager (PDM).
- * @param  selectedDevice [IN] Device to add to the provisioning database.
+ * @param[in] selectedDevice  Device to add to the provisioning database.
  * @return OC_STACK_OK in case of success and other values otherwise.
  */
 static OCStackResult SetupMOTPDM(OCProvisionDev_t *selectedDevice)
index 2642e10..13a3a69 100644 (file)
@@ -740,8 +740,8 @@ exit:
 /**
  * Function to handle the handshake result in OTM.
  * This function will be invoked after DTLS handshake
- * @param   endPoint  [IN] The remote endpoint.
- * @param   errorInfo [IN] Error information from the endpoint.
+ * @param[in] endPoint   The remote endpoint.
+ * @param[in] errorInfo  Error information from the endpoint.
  * @return  NONE
  */
 CAResult_t DTLSHandshakeCB(const CAEndpoint_t *endpoint, const CAErrorInfo_t *info)
index de69be6..8853c0e 100644 (file)
@@ -490,7 +490,7 @@ void SRMDeInitSecureResources(void)
 
 /**
  * Get the Secure Virtual Resource (SVR) type from the URI.
- * @param   uri [IN] Pointer to URI in question.
+ * @param[in] uri  Pointer to URI in question.
  * @return  The OicSecSvrType_t of the URI passed (note: if not a Secure Virtual
             Resource, e.g. /a/light, will return "NOT_A_SVR_TYPE" enum value)
  */
index 831ed06..b123e88 100644 (file)
@@ -282,7 +282,7 @@ bool SRMIsSecurityResourceURI(const char* uri)
 }
 
 /**
- * return true IFF the uri is for a DCR as defined by Security Specification.
+ * return true IFF the URI is for a DCR as defined by Security Specification.
  */
 bool IsDeviceConfigurationResourceUri(const char *uri)
 {
index 0345dc6..a1f30b4 100644 (file)
@@ -64,7 +64,7 @@ typedef struct resourcetype_t OCResourceType;
 
 /**
  * Data structure for holding client's callback context, methods and Time to Live,
- * connectivity Types, presence and resource type, request uri etc.
+ * connectivity Types, presence and resource type, request URI etc.
  */
 typedef struct ClientCB {
     /** callback method defined in application address space. */
@@ -105,7 +105,7 @@ typedef struct ClientCB {
     /** This is the sequence identifier the server applies to the invocation tied to 'handle'.*/
     uint32_t sequenceNumber;
 
-    /** The canonical form of the request uri associated with the call back.*/
+    /** The canonical form of the request URI associated with the call back.*/
     char * requestUri;
 
     /** Remote address complete.*/
@@ -157,7 +157,7 @@ extern struct ClientCB *g_cbList;
  *                                 Used for callback management.
  * @param[in]  method              A method via which this client callback is expected to operate
  * @param[in]  devAddr             The Device address.
- * @param[in]  requestUri          The resource uri of the request.
+ * @param[in]  requestUri          The resource URI of the request.
  * @param[in]  resourceTypeName    The resource type associated with a presence request.
  * @param[in]  ttl                 time to live in coap_ticks for the callback.
  *
@@ -216,7 +216,7 @@ ClientCB* GetClientCBUsingHandle(const OCDoHandle handle);
 
 #ifdef WITH_PRESENCE
 /**
- * This method is used to search and retrieve a cb node in cbList using a uri.
+ * This method is used to search and retrieve a cb node in cbList using a URI.
  *
  * @param[in]  requestUri           Uri to search for.
  *
index 6369687..8fee764 100644 (file)
@@ -31,7 +31,7 @@ OCStackResult DefaultCollectionEntityHandler (OCEntityHandlerFlag flag,
 
 /**
  * This function creates the RepPayloadArray for links parameter of collection resource.
- * @param[in] resourceUri Resource uri (this should be a collection resource)
+ * @param[in] resourceUri Resource URI (this should be a collection resource)
  * @param[in] devAddr Structure pointing to the address. (from OCEntityHandlerRequest)
  * @param[in] isOCFVer true if AcceptedVersion is OCF1.0 or higher
  *            otherwise false in case OIC1.1 (from OCEntityHandlerRequest)
index 6e40b39..7bf1c14 100644 (file)
@@ -332,7 +332,7 @@ bool OC_CALL OCByteStringCopy(OCByteString *dest, const OCByteString *source);
 
 /**
  * This function creates the payloadArray for links parameter of collection resource.
- * @param[in] resourceUri Resource uri (this should be a collection resource)
+ * @param[in] resourceUri Resource URI (this should be a collection resource)
  * @param[in] ehRequest parameter received from Entity Handler for client request
  * @param[in] insertSelfLink flag to specify whether links array can contain a self link
  * @param[out] createdArraySize return value array size, Null is allowed if no need to know size
index cdcf479..0f78596 100644 (file)
@@ -83,7 +83,7 @@ OCStackResult OC_CALL OCInit(const char *ipAddr, uint16_t port, OCMode mode);
 #ifdef RA_ADAPTER
 /**
  * @brief   Set Remote Access information for XMPP Client.
- * @param   raInfo            [IN] remote access info.
+ * @param[in] raInfo  remote access info.
  *
  * @return  ::OC_STACK_OK on success, some other value upon failure.
  */
@@ -149,7 +149,7 @@ OCStackResult OC_CALL OCProcess(void);
  * @param payload           Encoded request payload,
                             OCDoResource will free given payload when return OC_STATUS_OK.
  * @param connectivityType  Modifier flags when destination is not given.
- * @param qos               Quality of service. Note that if this API is called on a uri with the
+ * @param qos               Quality of service. Note that if this API is called on a URI with the
  *                          well-known multicast IP address, the qos will be forced to ::OC_LOW_QOS
  *                          since it is impractical to send other QOS levels on such addresses.
  * @param cbData            Asynchronous callback function that is invoked by the stack when
@@ -194,7 +194,7 @@ OCStackResult OC_CALL OCDoResource(OCDoHandle *handle,
  * @param payload           Encoded request payload.
                             OCDoRequest does not free given payload.
  * @param connectivityType  Modifier flags when destination is not given.
- * @param qos               Quality of service. Note that if this API is called on a uri with the
+ * @param qos               Quality of service. Note that if this API is called on a URI with the
  *                          well-known multicast IP address, the qos will be forced to ::OC_LOW_QOS
  *                          since it is impractical to send other QOS levels on such addresses.
  * @param cbData            Asynchronous callback function that is invoked by the stack when
@@ -643,9 +643,9 @@ OCStackResult OC_CALL OCNotifyListOfObservers (OCResourceHandle handle,
 OCStackResult OC_CALL OCDoResponse(OCEntityHandlerResponse *response);
 
 /**
- * This function sets uri being used for proxy.
+ * This function sets URI being used for proxy.
  *
- * @param uri            NULL terminated resource uri for CoAP-HTTP Proxy.
+ * @param uri            NULL terminated resource URI for CoAP-HTTP Proxy.
  */
 OCStackResult OC_CALL OCSetProxyURI(const char *uri);
 
@@ -673,7 +673,7 @@ OCStackResult OC_CALL OCGetResourceIns(OCResourceHandle handle, int64_t *ins);
 #ifdef RD_SERVER
 /**
  * Sets the filename to be used for database persistent storage.
- * @param   filename            [IN] the filename.
+ * @param[in] filename  the filename.
  *
  * @return  ::OC_STACK_OK on success, some other value upon failure.
  */
@@ -721,9 +721,9 @@ OCStackResult OC_CALL OCRDDatabaseDiscoveryPayloadCreateWithEp(const char *inter
 /**
 * This function gets a resource handle by resource uri.
 *
-* @param uri   Uri of Resource to get Resource handle.
+* @param uri URI of Resource to get Resource handle.
 *
-* @return Found  resource handle or NULL if not found.
+* @return Found resource handle or NULL if not found.
 */
 OCResourceHandle OC_CALL OCGetResourceHandleAtUri(const char *uri);
 
index 15c0dfd..4fdb371 100644 (file)
@@ -74,8 +74,8 @@ const char *getResult(OCStackResult result);
 /* Performs GET/PUT/POST query on most recently discovered resource*/
 void queryResource();
 
-/* Parses JSON payload received in the clientResponse to extract sid and resource uri information.
- * Populates uri_c array with uris of the resources discovered and assigns sid_c with the server
+/* Parses JSON payload received in the clientResponse to extract sid and resource URI information.
+ * Populates uri_c array with URIs of the resources discovered and assigns sid_c with the server
  * id received in the clientResponse.
  */
 int parseJSON(unsigned  const char * resJSONPayload, char ** sid_c,
index 9c10b50..2dc4dc3 100644 (file)
@@ -416,7 +416,7 @@ ClientCB* GetClientCBUsingUri(const char *requestUri)
     ClientCB* tmp = NULL;
     LL_FOREACH_SAFE(g_cbList, out, tmp)
     {
-        /* de-annotate below line if want to see all uri in g_cbList */
+        /* de-annotate below line if want to see all URI in g_cbList */
         //OIC_LOG_V(INFO, TAG, "%s", out->requestUri);
         if (out->requestUri && strcmp(out->requestUri, requestUri ) == 0)
         {
index 5effd50..1e11c9d 100644 (file)
@@ -75,10 +75,10 @@ static void OCAdapterStateChangedHandler(CATransportAdapter_t adapter, bool enab
 static void OCConnectionStateChangedHandler(const CAEndpoint_t *info, bool isConnected);
 
 /**
- * Check uri has device id.
+ * Check URI has device id.
  *
- * @param[in]  uri  uri of resource.
- * @return  true if uri has device id, or false.
+ * @param[in]  uri  URI of resource.
+ * @return  true if URI has device id, or false.
  */
 static bool OCCMHasDeviceId(const char *uri);
 
index e675c91..65d0bd0 100644 (file)
@@ -2951,7 +2951,7 @@ CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
 }
 
 /**
- *  A request uri consists of the following components in order:
+ *  A request URI consists of the following components in order:
  *                              example
  *  optionally one of
  *      CoAP over UDP prefix    "coap://"
@@ -3816,7 +3816,7 @@ OCStackResult OC_CALL OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHead
 
 /**
  * @brief   Register Persistent storage callback.
- * @param   persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
+ * @param[in] persistentStorageHandler  Pointers to open, read, write, close & unlink handlers.
  * @return
  *     OC_STACK_OK    - No errors; Success
  *     OC_STACK_INVALID_PARAM - Invalid parameter
@@ -5656,7 +5656,7 @@ OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
 }
 
 /*
- * This function splits the uri using the '?' delimiter.
+ * This function splits the URI using the '?' delimiter.
  * "uriWithoutQuery" is the block of characters between the beginning
  * till the delimiter or '\0' which ever comes first.
  * "query" is whatever is to the right of the delimiter if present.
@@ -5664,8 +5664,8 @@ OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
  * If either are present, they will be malloc'ed into the params 2, 3.
  * The first param, *uri is left untouched.
 
- * NOTE: This function does not account for whitespace at the end of the uri NOR
- *       malformed uri's with '??'. Whitespace at the end will be assumed to be
+ * NOTE: This function does not account for whitespace at the end of the URI NOR
+ *       malformed URIs with '??'. Whitespace at the end will be assumed to be
  *       part of the query.
  */
 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
index 17d226f..3ab2453 100644 (file)
@@ -181,7 +181,7 @@ OCStackResult HandleKeepAliveResponse(const CAEndpoint_t *endPoint,
 /**
  * Gets keepalive entry.
  * @param[in]   endpoint    Remote Endpoint information (like ipaddress,
- *                          port, reference uri and transport type) to
+ *                          port, reference URI and transport type) to
  *                          which the ping message has to be sent.
  * @param[out]  index       index of array list.
  * @return  KeepAlive entry to send ping message.
@@ -191,7 +191,7 @@ static KeepAliveEntry_t *GetEntryFromEndpoint(const CAEndpoint_t *endpoint, size
 /**
  * Add keepalive entry.
  * @param[in]   endpoint    Remote Endpoint information (like ipaddress,
- *                          port, reference uri and transport type).
+ *                          port, reference URI and transport type).
  * @param[in]   mode        Whether it is OIC Server or OIC Client.
  * @param[in]   intervalArray   Received interval values from cloud server.
  * @return  The KeepAlive entry added in KeepAlive Table.
@@ -202,7 +202,7 @@ KeepAliveEntry_t *AddKeepAliveEntry(const CAEndpoint_t *endpoint, OCMode mode,
 /**
  * Remove keepalive entry.
  * @param[in]   endpoint    Remote Endpoint information (like ipaddress,
- *                          port, reference uri and transport type).
+ *                          port, reference URI and transport type).
  * @return  The KeepAlive entry removed in KeepAlive Table.
  */
 static OCStackResult RemoveKeepAliveEntry(const CAEndpoint_t *endpoint);
index b3ddf7f..400db59 100644 (file)
@@ -42,7 +42,7 @@ public:
     /**
      * constructor
      *
-     * @param resourceUri the uri the resource will be register with
+     * @param resourceUri the URI the resource will be register with
      */
     BinarySwitchResource(std::string resourceUri = "/binaryswitch");
 
index 7d93b0b..a50ed51 100644 (file)
@@ -36,7 +36,7 @@ public:
     /*
      * constructor
      *
-     * @param resourceUri the uri the resource will be register with
+     * @param resourceUri the URI the resource will be register with
      */
     DimmingResource(std::string resourceUri = "/dimming");
 
index 4b5360f..d1ee633 100644 (file)
@@ -125,11 +125,11 @@ namespace OC
                     QualityOfService QoS);
 
         /**
-        * Gets a resource handle by resource uri.
+        * Gets a resource handle by resource URI.
         *
-        * @param uri   Uri of Resource to get Resource handle.
+        * @param uri   URI of Resource to get Resource handle.
         *
-        * @return Found  resource handle or NULL if not found.
+        * @return Found resource handle or NULL if not found.
         */
         OCResourceHandle getResourceHandleAtUri(const std::string& uri);
 
@@ -226,7 +226,7 @@ namespace OC
          *
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param deviceURI Uri containing address to the virtual device in C Stack
+         * @param deviceURI URI containing address to the virtual device in C Stack
                                 ("/oic/d")
          * @param connectivityType ::OCConnectivityType type of connectivity indicating the
          *                           interface. Example: CT_DEFAULT, CT_ADAPTER_IP, CT_ADAPTER_TCP.
@@ -242,7 +242,7 @@ namespace OC
          * @overload
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param deviceURI Uri containing address to the virtual device in C Stack
+         * @param deviceURI URI containing address to the virtual device in C Stack
                                 ("/oic/d")
          * @param connectivityType ::OCConnectivityType type of connectivity indicating the
          *                           interface. Example: CT_DEFAULT, CT_ADAPTER_IP, CT_ADAPTER_TCP.
@@ -259,7 +259,7 @@ namespace OC
          *
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param platformURI Uri containing address to the virtual platform in C Stack
+         * @param platformURI URI containing address to the virtual platform in C Stack
                                 ("/oic/p")
          * @param connectivityType ::OCConnectivityType type of connectivity indicating the
          *                           interface. Example: CT_DEFAULT, CT_ADAPTER_IP, CT_ADAPTER_TCP.
@@ -276,7 +276,7 @@ namespace OC
          * @overload
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param platformURI Uri containing address to the virtual platform in C Stack
+         * @param platformURI URI containing address to the virtual platform in C Stack
                                 ("/oic/p")
          * @param connectivityType ::OCConnectivityType type of connectivity indicating the
          *                           interface. Example: CT_DEFAULT, CT_ADAPTER_IP, CT_ADAPTER_TCP.
@@ -689,7 +689,7 @@ namespace OC
          * to be a Client or Client/Server.  Otherwise, this will return an empty
          * shared ptr.
          *
-         * @param host a string containing a resolvable "coap(s)", "coap(s)+protocol" uri scheme
+         * @param host a string containing a resolvable "coap(s)", "coap(s)+protocol" URI scheme
          *        of the server holding the resource.
          *        Currently this should be in the format coap(s)://address:port or
          *        coap(s)+protocol://address:port, though in the future, we expect this to
index ec8da58..90a964e 100644 (file)
@@ -119,7 +119,7 @@ namespace OC
          * API for Device Discovery
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param deviceURI Uri containing address to the virtual device in C Stack
+         * @param deviceURI URI containing address to the virtual device in C Stack
          *                       ("/oic/d")
          * @param deviceInfoHandler device discovery callback
          * @param QualityOfService the quality of communication
@@ -135,7 +135,7 @@ namespace OC
          * API for Platform Discovery
          *
          * @param host Host IP Address. If null or empty, Multicast is performed.
-         * @param platformURI Uri containing address to the virtual platform in C Stack
+         * @param platformURI URI containing address to the virtual platform in C Stack
          *                       ("/oic/p")
          * @param platformInfoHandler platform discovery callback
          * @param QualityOfService the quality of communication
index f36783b..c977a04 100644 (file)
@@ -581,7 +581,7 @@ namespace OC
         * SubTopic is also created through this method.
         *
         * @param rep representation of the topic
-        * @param topicUri new uri of the topic which want to create
+        * @param topicUri new URI of the topic which want to create
         * @param queryParametersMap map which can have the query parameter name and value
         * @param attributeHandler handles callback
         * @param qos the quality of communication
index 6761f5d..152fa73 100644 (file)
@@ -140,8 +140,8 @@ namespace OC
         const ObservationInfo& getObservationInfo() const {return m_observationInfo;}
 
         /**
-        *  sets resource uri
-        *  @param resourceUri specifies the resource uri
+        *  sets resource URI
+        *  @param resourceUri specifies the resource URI
         */
         void setResourceUri(const std::string resourceUri)
         {
@@ -149,8 +149,8 @@ namespace OC
         }
 
         /**
-        *  gets resource uri
-        *  @return std::string resource uri
+        *  gets resource URI
+        *  @return std::string resource URI
         */
         std::string getResourceUri(void)
         {
index 023ad82..bbe5455 100644 (file)
@@ -84,8 +84,8 @@ namespace OC
         virtual ~OCResourceResponse(void) {}
 
         /**
-        *  gets new resource uri
-        *  @return std::string new resource uri
+        *  gets new resource URI
+        *  @return std::string new resource URI
         */
         std::string getNewResourceUri(void)
         {
@@ -93,8 +93,8 @@ namespace OC
         }
 
         /**
-        *  sets new resource uri
-        *  @param newResourceUri specifies the resource uri of the resource created
+        *  sets new resource URI
+        *  @param newResourceUri specifies the resource URI of the resource created
         */
         void setNewResourceUri(const std::string newResourceUri)
         {
index f1c9304..129db0c 100644 (file)
@@ -38,7 +38,7 @@ namespace OC {
 
         /*
          * @brief helper function that parses the query parameters component
-         * of a URI into a key-value map.  This function expects the uri
+         * of a URI into a key-value map.  This function expects the URI
          * parameter to contain the query parameters component of a URI
          * (everything after the '?', excluding anything anchors).
          *
index e6a8eb6..b17e6b7 100644 (file)
@@ -226,8 +226,8 @@ OCEntityHandlerResult CHPEntityHandler(OCEntityHandlerFlag flag,
     {
         /*
          *  A proxy can handle two type of requests:
-         *  1. Discovery request in which case proxy-uri option will not be present.
-         *  2. Request for HTTP resource with proxy-uri option.
+         *  1. Discovery request in which case proxy-URI option will not be present.
+         *  2. Request for HTTP resource with proxy-URI option.
          */
         char proxyUri[MAX_HEADER_OPTION_DATA_LENGTH] = {'\0'};
         CHPGetProxyURI(entityHandlerRequest->rcvdVendorSpecificHeaderOptions,
index a8a085b..688f0a2 100644 (file)
@@ -726,9 +726,9 @@ static OCStackResult CHPInitializeEasyHandle(CURL** easyHandle, HttpRequest_t *r
         return OC_STACK_ERROR;
     }
 
-    /* Set http resource uri */
+    /* Set http resource URI */
     curl_easy_setopt(e, CURLOPT_URL, req->resourceUri);
-    /* Default protocol when scheme is not available in uri */
+    /* Default protocol when scheme is not available in URI */
     // curl version 7.22 don't support this option.
     //curl_easy_setopt(e, CURLOPT_DEFAULT_PROTOCOL, "http");
     /* Set handle context */
index 83f7dc4..88f3cb4 100644 (file)
@@ -80,7 +80,7 @@ namespace OIC
 \r
                 /**\r
                       * Request to subscribe to remote MQ address as parameter.\r
-                      * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :\r
+                      * @param[in] serverAddress server address combined with IP address and port number and MQ broker URI using delimiter :\r
                       * @param[in] topicName the interest Topic name for subscription.\r
                       * @return ::NS_OK or result code of NSResult\r
                       */\r
index 91ba4ae..842495a 100644 (file)
@@ -119,7 +119,7 @@ namespace OIC
 \r
                 /**\r
                       * Request to subscribe to remote MQ address as parameter.\r
-                      * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :\r
+                      * @param[in] serverAddress server address combined with IP address and port number and MQ broker URI using delimiter :\r
                       * @param[in] topicName the interest Topic name for subscription.\r
                       * @return ::NS_OK or result code of NSResult\r
                       */\r
index 14052db..6f54281 100644 (file)
@@ -87,7 +87,7 @@ NSResult NSConsumerEnableRemoteService(const char * serverAddress);
 #ifdef WITH_MQ
 /**
  * Request to subscribe to remote MQ address as parameter.
- * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :
+ * @param[in] serverAddress server address combined with IP address and port number and MQ broker URI using delimiter :
  * @param[in] topicName the interest MQ Topic name for subscription.
  * @return ::NS_OK or result code of NSResult
  */
index b4a0432..9ee1e77 100644 (file)
@@ -101,7 +101,7 @@ NSResult NSProviderDisableRemoteService(char * serverAddress);
 #ifdef WITH_MQ
 /**
  * Request to subscribe to remote MQ address as parameter.
- * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :
+ * @param[in] serverAddress server address combined with IP address and port number and MQ broker URI using delimiter :
  * @param[in] topicName the interest Topic name for subscription.
  * @return ::NS_OK or result code of NSResult
  */
index 1cd6357..e0b3c00 100644 (file)
@@ -57,7 +57,7 @@ namespace OIC
                 /**
                 * Callback method for getting notification from bundle resources
                 *
-                * @param strResourceUri Uri of attribute updated bundle resource
+                * @param strResourceUri URI of attribute updated bundle resource
                 *
                 * @return void
                 */
index f2feee9..bb4a8c1 100644 (file)
@@ -92,7 +92,7 @@ namespace OIC
                  * API for adding the bundle to the Container
                  *
                  * @param bundleId Id of the Bundle
-                 * @param bundleUri Uri of the bundle
+                 * @param bundleUri URI of the bundle
                  * @param bundlePath Path of the bundle
                  * @param activator Activation prefix for .so bundles, or activator class name for .jar bundles
                  * @param params  key-value pairs in string form for other Bundle parameters
index c368e55..5aaba8d 100644 (file)
@@ -101,7 +101,7 @@ namespace OIC
             static RCSDiscoveryManager* getInstance();
 
             /**
-             * Discovers resources of interest, regardless of uri and resource type.
+             * Discovers resources of interest, regardless of URI and resource type.
              * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address         A RCSAddress object
@@ -120,7 +120,7 @@ namespace OIC
              * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param cb               A callback to obtain discovered resource
              *
              * @throws InvalidParameterException If cb is empty.
@@ -172,7 +172,7 @@ namespace OIC
              * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param resourceType     Resource Type
              * @param cb               A callback to obtain discovered resource
              *
@@ -190,7 +190,7 @@ namespace OIC
              * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param resourceTypes     List of Resource Types
              * @param cb               A callback to obtain discovered resource
              *
index b0cd588..ee632c4 100644 (file)
@@ -544,7 +544,7 @@ namespace OIC
                     SetCallback cb);
 
             /**
-             * Returns the uri of the resource.
+             * Returns the URI of the resource.
              *
              */
             std::string getUri() const;
index bd17166..d090c3c 100644 (file)
@@ -55,12 +55,12 @@ namespace OIC
                     const RCSResourceAttributes& attrs);
 
             /**
-             * Returns the uri.
+             * Returns the URI.
              */
             std::string getUri() const;
 
             /**
-             * Sets the uri of this representation.
+             * Sets the URI of this representation.
              */
             void setUri(std::string uri);
 
index 506cd9a..c35f1b8 100644 (file)
@@ -161,7 +161,7 @@ namespace OIC
                 /**
                  * Constructs a Builder.
                  *
-                 * @param uri Resource uri
+                 * @param uri Resource URI
                  * @param type Resource type
                  * @param interface Resource interface
                  *
@@ -533,7 +533,7 @@ namespace OIC
             std::vector< RCSResourceObject::Ptr > getBoundResources() const;
 
             /**
-             * Returns the uri of the resource.
+             * Returns the URI of the resource.
              */
             std::string getUri() const;
 
index 0f728b0..f8286e4 100644 (file)
@@ -94,7 +94,7 @@ namespace OIC
                  * @return DiscoverTask pointer
                  *
                  * @param address        A RCSAddress object
-                 * @param relativeURI    The relative uri of resource to be searched
+                 * @param relativeURI    The relative URI of resource to be searched
                  * @param resourceType   Resource Type
                  * @param cb             A callback to obtain discovered resource
                  *
index 1958757..8a2c8b5 100644 (file)
@@ -88,11 +88,11 @@ namespace OIC
             static std::string OICGenerateUUIDStr();
 
             /**
-             * Returns host resource's address and uri from coap address.
+             * Returns host resource's address and URI from coap address.
              *
-             * @param address uri of host resource (e.g. coap://192.168.0.2:12345/a/light)
+             * @param address URI of host resource (e.g. coap://192.168.0.2:12345/a/light)
              * @param[out] host host resource's address (e.g. 192.168.0.2:12345)
-             * @param[out] uri host resource's uri (e.g. /a/light)
+             * @param[out] uri host resource's URI (e.g. /a/light)
              *
              * @throw RCSInvalidParameterException
              */
@@ -112,7 +112,7 @@ namespace OIC
             /**
             * Returns RCSRemoteResourceObject pointer created with provided resource information.
             *
-            * @param address uri of resource (e.g. coap://192.168.0.2:12345/a/light)
+            * @param address URI of resource (e.g. coap://192.168.0.2:12345/a/light)
             * @param ct OCConnectivityType type of connectivity indicating the interface
             * @param vecRT a vector of resource types implemented by the resource
             * @param vecIF a vector of interfaces that the resource supports/implements
index c49ade9..31df8d6 100644 (file)
@@ -218,7 +218,7 @@ namespace RAML
                    * @param resourceKey - name of the Resource\r
                    * @param yamlNode - Reference to YamlNode for reading the RamlResource\r
                    * @param includeResolver - Reference to IncludeResolver for reading external files\r
-                   * @param parentUri - Uri of the Parent to form the Absolute Uri\r
+                   * @param parentUri - URI of the Parent to form the Absolute URI\r
                    *\r
                    */\r
             RamlResource(const std::string &resourceKey, const YAML::Node &yamlNode ,\r
index 7e489e3..6242bdb 100644 (file)
@@ -115,9 +115,9 @@ class ResourceURIFactory
         /**
          * API to construct unique URI from the given base @uri.
          *
-         * @param uri - Base uri to be used to construct unique uri.
+         * @param uri - Base URI to be used to construct unique URI.
          *
-         * @return Unique uri.
+         * @return Unique URI.
          */
         std::string makeUniqueURI(const std::string &uri);