Add missing description for stream ducking API

Missing @retval for SOUND_MANAGER_ERROR_INVALID_STATE is added.
More @post and @pre description are added.

[Version] 0.6.40
[Issue Type] Doxygen

Change-Id: I93a8513556211445e16000a6b31a7dce5f15bb8b
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/include/sound_manager.h b/include/sound_manager.h
index b03075f..75b422b 100644 (file)
--- a/include/sound_manager.h
+++ b/include/sound_manager.h
@@ -546,6 +546,7 @@ int sound_manager_create_stream_ducking(sound_stream_type_e target_stream, sound
  * @retval #SOUND_MANAGER_ERROR_NONE Success
  * @retval #SOUND_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SOUND_MANAGER_ERROR_INTERNAL Internal error inside the sound system
+ * @retval #SOUND_MANAGER_ERROR_INVALID_STATE Invalid state
  * @see sound_manager_create_stream_ducking()
  * @see sound_manager_destroy_stream_ducking()
  * @see sound_manager_activate_ducking()
@@ -574,6 +575,7 @@ int sound_manager_is_ducked(sound_stream_ducking_h stream_ducking, bool *is_duck
  * @retval #SOUND_MANAGER_ERROR_INTERNAL Internal error inside the sound system
  * @pre The stream should be unducked before calling this function,
  *      otherwise, #SOUND_MANAGER_ERROR_INVALID_STATE is returned.
+ * @post sound_stream_ducking_state_changed_cb() will be invoked.
  * @see sound_manager_create_stream_ducking()
  * @see sound_manager_destroy_stream_ducking()
  * @see sound_manager_is_ducked()
@@ -596,6 +598,7 @@ int sound_manager_activate_ducking(sound_stream_ducking_h stream_ducking, unsign
  * @retval #SOUND_MANAGER_ERROR_INTERNAL Internal error inside the sound system
  * @pre The stream should be ducked before calling this function,
  *      otherwise, #SOUND_MANAGER_ERROR_INVALID_STATE is returned.
+ * @post sound_stream_ducking_state_changed_cb() will be invoked.
  * @see sound_manager_create_stream_ducking()
  * @see sound_manager_destroy_stream_ducking()
  * @see sound_manager_is_ducked()
@@ -613,6 +616,9 @@ int sound_manager_deactivate_ducking(sound_stream_ducking_h stream_ducking);
  * @retval #SOUND_MANAGER_ERROR_NONE Success
  * @retval #SOUND_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SOUND_MANAGER_ERROR_INTERNAL Internal error inside the sound system
+ * @retval #SOUND_MANAGER_ERROR_INVALID_STATE Invalid state
+ * @pre The stream should be unducked before calling this function,
+ *      otherwise, #SOUND_MANAGER_ERROR_INVALID_STATE is returned.
  * @see sound_manager_create_stream_ducking()
  * @see sound_manager_is_ducked()
  * @see sound_manager_activate_ducking()

diff --git a/packaging/capi-media-sound-manager.spec b/packaging/capi-media-sound-manager.spec
index f180f19..0b3fd70 100644 (file)
--- a/packaging/capi-media-sound-manager.spec
+++ b/packaging/capi-media-sound-manager.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-sound-manager
 Summary:    Sound Manager library
-Version:    0.6.39
+Version:    0.6.40
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0