libsession: update doxygen API documentation

Provided doxgen API documentation wasn't complete and accurate:
not all possible error codes were listed as well as the description for
the `unregister_event_callback` API call was inaccurate.

Change-Id: Ib3da4e8f1ad6f50f9b14ac84f25b8d3b6b07c543

diff --git a/src/library/include/sessiond.h b/src/library/include/sessiond.h
index 28632792e685736e00802401739d7646f513e3d4..16e5b03a1384233b2431e7ff3c7b1486540f9144 100644 (file)
--- a/src/library/include/sessiond.h
+++ b/src/library/include/sessiond.h
@@ -105,6 +105,7 @@ typedef void (*subsession_reply_callback) (int result, void *user_data);
  * @return 0 on success, otherwise a negative error value
  * @retval #SUBSESSION_ERROR_NONE Success
  * @retval #SUBSESSION_ERROR_INVALID_PARAMETER Provided parameter is invalid
+ * @retval #SUBSESSION_ERROR_ALREADY_EXISTS Provided subsession already exists
  * @retval #SUBSESSION_ERROR_OUT_OF_MEMORY Out of memory
  * @remarks Use `subsession_get_user_list()` to list currently used session IDs.
  *  Subsession ID must not start with a dot or have slashes.
@@ -123,6 +124,7 @@ int subsession_add_user(int session_uid, const subsession_user_t user, subsessio
  * @return 0 on success, otherwise a negative error value
  * @retval #SUBSESSION_ERROR_NONE Success
  * @retval #SUBSESSION_ERROR_INVALID_PARAMETER Provided parameter is invalid
+ # @retval #SUBSESSION_ERROR_NOT_AVAILABLE Provided subsession does not exist
  * @retval #SUBSESSION_ERROR_OUT_OF_MEMORY Out of memory
  * @remarks Subsession ID must not start with a dot or have slashes.
  * Only inactive session ID can be removed. \n
@@ -143,6 +145,7 @@ int subsession_remove_user(int session_uid, const subsession_user_t user, subses
  * @return 0 on success, otherwise a negative error value
  * @retval #SUBSESSION_ERROR_NONE Success
  * @retval #SUBSESSION_ERROR_INVALID_PARAMETER Provided parameter is invalid
+ * @retval #SUBSESSION_ERROR_NOT_AVAILABLE Provided subsession to be switched to does not exist
  * @retval #SUBSESSION_ERROR_OUT_OF_MEMORY Out of memory
  * @remarks Subsession ID must not start with a dot or have slashes.
  * Special subsession ID "" (empty string) can be switched to, when it's required to deactivate
@@ -226,6 +229,7 @@ typedef void (*subsession_event_callback) (subsession_event_info info, void *use
  * @return 0 on success, otherwise a negative error value
  * @retval #SUBSESSION_ERROR_NONE Success
  * @retval #SUBSESSION_ERROR_INVALID_PARAMETER Provided parameter is invalid
+ * @retval #SUBSESSION_ERROR_ALREADY_EXISTS Callback for the provided User ID has already been registered
  * @retval #SUBSESSION_ERROR_IO_ERROR Internal error occurred
  * @retval #SUBSESSION_ERROR_PERMISSION_DENIED Not permitted
  * @retval #SUBSESSION_ERROR_NOT_SUPPORTED Not supported
@@ -243,8 +247,7 @@ int subsession_register_event_callback(int session_uid, subsession_event_type_e
  * @return 0 on success, otherwise a negative error value
  * @retval #SUBSESSION_ERROR_NONE Success
  * @retval #SUBSESSION_ERROR_INVALID_PARAMETER Provided parameter is invalid
- * If one bit was set in event_bits then this errors means that this particular event was not registered previously \n
- * If more than one bit was set in event_bit then this error means that at least one of specified events was not registered
+ * @retval #SUBSESSION_ERROR_NOT_AVAILABLE Callback for the provided User ID has not been registered
  * @retval #SUBSESSION_ERROR_IO_ERROR Internal error occurred
  * @retval #SUBSESSION_ERROR_PERMISSION_DENIED Not permitted
  * @retval #SUBSESSION_ERROR_NOT_SUPPORTED Not supported