Added commentary to the public API referring to new functionality of

notifications when a resource is deleted or when a server is shutdown
gracefully.

Patch 2: Edited commentary to OCStop() as per Erich's review.

Change-Id: I0b71bd3245072ac8f7cf9f67dff66b3d8b501355

diff --git a/csdk/stack/include/ocstack.h b/csdk/stack/include/ocstack.h
index af6f77e..f1a04fd 100644 (file)
--- a/csdk/stack/include/ocstack.h
+++ b/csdk/stack/include/ocstack.h
@@ -347,6 +347,12 @@ OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode);
 
 /**
  * Stop the OC stack.  Use for a controlled shutdown.
+ *
+ * Note: OCStop() performs operations similar to OCStopPresence(), as well as OCDeleteResource() on
+ * all resources this server is hosting. OCDeleteResource() performs operations similar to
+ * OCNotifyAllObservers() to notify all client observers that the respective resource is being
+ * deleted.
+ *
  * @return
  *     OC_STACK_OK    - no errors
  *     OC_STACK_ERROR - stack not initialized
@@ -561,6 +567,9 @@ OCResourceHandle OCGetResourceHandle(uint8_t index);
  * Delete resource specified by handle.  Deletes resource and all resourcetype and resourceinterface
  * linked lists.
  *
+ * Note: OCDeleteResource() performs operations similar to OCNotifyAllObservers() to notify all
+ * client observers that "this" resource is being deleted.
+ *
  * @param handle - handle of resource to be deleted
  *
  * @return