From 0e76bd4b2e27f2fac12e92453bdc3fb5e94652ac Mon Sep 17 00:00:00 2001 From: Sangchul Lee Date: Tue, 16 Aug 2016 15:07:34 +0900 Subject: [PATCH] Move @remarks to above @param [Version] Release 0.3.59 [Profile] Common [Issue Type] Description Change-Id: I435926ce68a2f2a12f6aaee6e54b120e9ddfdfcb Signed-off-by: Sangchul Lee --- include/sound_manager.h | 76 ++++++++++++++++----------------- include/sound_manager_internal.h | 32 ++++++-------- packaging/capi-media-sound-manager.spec | 2 +- 3 files changed, 52 insertions(+), 58 deletions(-) diff --git a/include/sound_manager.h b/include/sound_manager.h index 08a3e44..7c1eaa4 100644 --- a/include/sound_manager.h +++ b/include/sound_manager.h @@ -335,14 +335,14 @@ typedef void (*sound_manager_volume_changed_cb) (sound_type_e type, unsigned int /** * @brief Called when the state of focus that belongs to the stream_info is changed. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] reason The reason for state change of the focus - * @param[in] extra_info The extra information - * @param[in] user_data The user data passed from the callback registration function * * @remarks This function is issued in the internal thread of the sound manager.\n * Therefore it is recommended not to call UI update function in this function. * + * @param[in] stream_info The handle of stream information + * @param[in] reason The reason for state change of the focus + * @param[in] extra_info The extra information + * @param[in] user_data The user data passed from the callback registration function * @pre You should register this callback using sound_manager_create_stream_information(). * @post Use sound_manager_get_focus_state() in this callback to figure out how the focus state of the stream_info has been changed. * @see sound_manager_create_stream_information() @@ -558,17 +558,17 @@ int sound_manager_unset_volume_changed_cb(void); /** * @brief Creates a handle for stream information. * @since_tizen 3.0 - * @details To apply the stream policy according to this stream information, this handle should be passed to other APIs\n - * related to playback or recording. (e.g., player, wav-player, audio-io, etc.) + * + * @remarks The registered callback is issued in the internal thread of the sound manager.\n + * Do not call this API within sound_stream_focus_state_changed_cb() or sound_stream_focus_state_watch_cb(),\n + * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned.\n + * To apply the stream policy according to this stream information, this handle should be passed to other APIs\n + * related to playback or recording.(e.g. player, wav-player, audio-io, etc.) + * * @param[in] stream_type The type of stream * @param[in] callback The focus state change callback function (mandatory) * @param[in] user_data The user data to be passed to the callback function * @param[out] stream_info The handle of stream information - * - * @remarks The registered callback is issued in the internal thread of the sound manager.\n - * Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n - * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned. - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -589,11 +589,11 @@ int sound_manager_create_stream_information(sound_stream_type_e stream_type, sou /** * @brief Destroys the handle for stream information. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information * - * @remarks Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n + * @remarks Do not call this API within sound_stream_focus_state_changed_cb() or sound_stream_focus_state_watch_cb(),\n * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned. * + * @param[in] stream_info The handle of stream information * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -613,13 +613,13 @@ int sound_manager_destroy_stream_information(sound_stream_info_h stream_info); /** * @brief Adds the device to the stream information for the stream routing. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] device The device item from sound_device_list_h * * @remarks Use sound_manager_get_current_device_list() and sound_manager_get_next_device() to get the device.\n * SOUND_MANAGER_ERROR_POLICY could be returned according to the stream type of the stream_info.\n * The available types of the stream_info for this API are SOUND_STREAM_TYPE_VOIP and SOUND_STREAM_TYPE_MEDIA_EXTERNAL_ONLY. * + * @param[in] stream_info The handle of stream information + * @param[in] device The device item from sound_device_list_h * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -637,11 +637,11 @@ int sound_manager_add_device_for_stream_routing(sound_stream_info_h stream_info, /** * @brief Removes the device to the stream information for the stream routing. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] device The device item from sound_device_list_h * * @remarks Use sound_manager_get_current_device_list() and sound_manager_get_next_device() to get the device.\n * + * @param[in] stream_info The handle of stream information + * @param[in] device The device item from sound_device_list_h * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -658,10 +658,10 @@ int sound_manager_remove_device_for_stream_routing(sound_stream_info_h stream_in /** * @brief Applies the stream routing. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information * * @remarks If the stream has not been made yet, this setting will be applied when the stream starts to play.\n * + * @param[in] stream_info The handle of stream information * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -679,13 +679,13 @@ int sound_manager_apply_stream_routing(sound_stream_info_h stream_info); /** * @brief Acquires the stream focus. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] focus_mask The focus mask that user wants to acquire - * @param[in] extra_info The Extra information for this request (optional, this can be null) * - * @remarks Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n + * @remarks Do not call this API within sound_stream_focus_state_changed_cb() or sound_stream_focus_state_watch_cb(),\n * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned. * + * @param[in] stream_info The handle of stream information + * @param[in] focus_mask The focus mask that user wants to acquire + * @param[in] extra_info The Extra information for this request (optional, this can be null) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -705,13 +705,13 @@ int sound_manager_acquire_focus(sound_stream_info_h stream_info, sound_stream_fo /** * @brief Releases the acquired focus. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] focus_mask The focus mask that user wants to release - * @param[in] extra_info TheExtra information for this request (optional, this can be null) * - * @remarks Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n + * @remarks Do not call this API within sound_stream_focus_state_changed_cb() or sound_stream_focus_state_watch_cb(),\n * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned. * + * @param[in] stream_info The handle of stream information + * @param[in] focus_mask The focus mask that user wants to release + * @param[in] extra_info TheExtra information for this request (optional, this can be null) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -749,12 +749,12 @@ int sound_manager_get_focus_state(sound_stream_info_h stream_info, sound_stream_ /** * @brief Sets auto focus reacquisition property. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] enable The auto focus reacquisition property to set : (@c true = enable, @c false = disable) * * @remarks The focus reacquistion is set as default. * If you don't want to reacquire the focus you've lost automatically, disable the focus reacqusition setting by using this API and vice versa. * + * @param[in] stream_info The handle of stream information + * @param[in] enable The auto focus reacquisition property to set : (@c true = enable, @c false = disable) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -767,11 +767,11 @@ int sound_manager_set_focus_reacquisition(sound_stream_info_h stream_info, bool /** * @brief Gets auto focus reacquisition property. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[out] enabled The value of focus auto reacquisition property : (@c true = enabled, @c false = disabled) * * @remarks The default value is true. * + * @param[in] stream_info The handle of stream information + * @param[out] enabled The value of focus auto reacquisition property : (@c true = enabled, @c false = disabled) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -784,12 +784,12 @@ int sound_manager_get_focus_reacquisition(sound_stream_info_h stream_info, bool /** * @brief Gets the sound type of the stream information. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[out] sound_type The sound type * * @remarks In case of the stream_info made with #SOUND_STREAM_TYPE_EMERGENCY, it'll return #SOUND_MANAGER_ERROR_NO_DATA.\n * Because there is no sound_type_e matched to this stream_info. * + * @param[in] stream_info The handle of stream information + * @param[out] sound_type The sound type * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -1051,12 +1051,12 @@ int sound_manager_unset_session_interrupted_cb(void); /** * @brief Gets the list consisting of connected devices. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] device_mask The mask value - * @param[out] device_list The list of connected devices * * @remarks @a device_list should be freed using sound_manager_free_device_list() since 3.0.\n * Use sound_manager_get_next_device() to get the first node of the list. * + * @param[in] device_mask The mask value + * @param[out] device_list The list of connected devices * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -1077,10 +1077,10 @@ int sound_manager_get_current_device_list(sound_device_mask_e device_mask, sound /** * @brief Frees device list and each item of list. * @since_tizen 3.0 - * @param[in] device_list The device list got with sound_manager_get_current_device_list. * * @remarks This API will deallocate not only device list itself but also each item. * + * @param[in] device_list The device list got with sound_manager_get_current_device_list. * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -1244,12 +1244,12 @@ int sound_manager_get_device_state(sound_device_h device, sound_device_state_e * /** * @brief Registers a callback function to be invoked when the state of connection of a sound device was changed. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] device_mask The mask value - * @param[in] callback The interrupted callback function - * @param[in] user_data The user data to be passed to the callback function * * @remarks The initial state of sound devices connected is deactivated. * + * @param[in] device_mask The mask value + * @param[in] callback The interrupted callback function + * @param[in] user_data The user data to be passed to the callback function * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success diff --git a/include/sound_manager_internal.h b/include/sound_manager_internal.h index 50ca8c4..9f6e921 100644 --- a/include/sound_manager_internal.h +++ b/include/sound_manager_internal.h @@ -119,16 +119,16 @@ int sound_manager_get_master_volume(int *level); * @internal * @brief Creates a handle for stream information. * @since_tizen 3.0 - * @details To apply the stream policy according to this stream information, this handle should be passed to other APIs\n - * related to playback or recording. (e.g., player, wav-player, audio-io, etc.) + * + * @remarks Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n + * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned.\n + * To apply the stream policy according to this stream information, this handle should be passed to other APIs\n + * related to playback or recording.(e.g. player, wav-player, audio-io, etc.) + * * @param[in] stream_type The type of stream for internal usage * @param[in] callback The focus state change callback function * @param[in] user_data The user data to be passed to the callback function * @param[out] stream_info The handle of stream information - * - * @remarks Do not call this API within sound_stream_focus_state_changed_cb() and sound_stream_focus_state_watch_cb(),\n - * otherwise SOUND_MANAGER_ERROR_INVALID_OPERATION will be returned. - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -149,12 +149,12 @@ int sound_manager_create_stream_information_internal(sound_stream_type_internal_ * @internal * @brief Sets the stream routing option. * @since_tizen 3.0 - * @param[in] stream_info The handle of stream information - * @param[in] name The name of option - * @param[in] value The value of option * * @remarks If the stream has not been made yet, this setting will be applied when the stream starts to play. * + * @param[in] stream_info The handle of stream information + * @param[in] name The name of option + * @param[in] value The value of option * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -175,7 +175,6 @@ int sound_manager_set_stream_routing_option(sound_stream_info_h stream_info, con * @param[in] stream_info The handle of stream information * @param[in] api_name The native API name * @param[out] is_available If @c true the api_name is available, @c false the api_name is not available for this strema_info - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -191,7 +190,6 @@ int sound_manager_is_available_stream_information(sound_stream_info_h stream_inf * @since_tizen 3.0 * @param[in] stream_info The handle of stream information * @param[out] type The stream type - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -221,11 +219,11 @@ int sound_manager_get_index_from_stream_information(sound_stream_info_h stream_i * @internal * @brief Gets the reason for the current acquired playback focus. * @since_tizen 3.0 - * @param[out] acquired_by The reason for the current acquired playback focus - * @param[out] extra_info The extra information of the acquired playback focus (this can be null) * * @remarks If there is no acquired playback focus in this system, it'll return #SOUND_MANAGER_ERROR_NO_DATA. * + * @param[out] acquired_by The reason for the current acquired playback focus + * @param[out] extra_info The extra information of the acquired playback focus (this can be null) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -239,11 +237,11 @@ int sound_manager_get_reason_for_current_playback_focus(sound_stream_focus_chang * @internal * @brief Gets the reason for the current acquired recording focus. * @since_tizen 3.0 - * @param[out] acquired_by The reason for the current acquired recording focus - * @param[out] extra_info The extra information of the acquired recording focus (this can be null) * * @remarks If there is no acquired recording focus in this system, it'll return #SOUND_MANAGER_ERROR_NO_DATA. * + * @param[out] acquired_by The reason for the current acquired recording focus + * @param[out] extra_info The extra information of the acquired recording focus (this can be null) * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -259,7 +257,6 @@ int sound_manager_get_reason_for_current_recording_focus(sound_stream_focus_chan * @since_tizen 3.0 * @param[in] stream_info The handle of stream information * @param[out] virtual_stream The handle of virtual stream - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -279,7 +276,6 @@ int sound_manager_create_virtual_stream(sound_stream_info_h stream_info, virtual * @brief Destroys the virtual stream handle. * @since_tizen 3.0 * @param[in] virtual_stream The handle of virtual stream - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -296,7 +292,6 @@ int sound_manager_destroy_virtual_stream(virtual_sound_stream_h virtual_stream); * @brief Starts the virtual stream. * @since_tizen 3.0 * @param[in] virtual_stream The handle of virtual stream - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success @@ -314,7 +309,6 @@ int sound_manager_start_virtual_stream(virtual_sound_stream_h virtual_stream); * @brief Stops the virtual stream. * @since_tizen 3.0 * @param[in] virtual_stream The handle of virtual stream - * * @return @c 0 on success, * otherwise a negative error value * @retval #SOUND_MANAGER_ERROR_NONE Success diff --git a/packaging/capi-media-sound-manager.spec b/packaging/capi-media-sound-manager.spec index 5bd8ba4..7bb96cb 100755 --- 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.3.58 +Version: 0.3.59 Release: 0 Group: Multimedia/API License: Apache-2.0 -- 2.7.4