sound_manager_internal: Fix documentation

Unused @remarks are removed.
Add missing parameter variables.
Add missing @internal commands.
Revise @brief of sound_manager_set_echo_cancel_reference_device()

[Version] 0.6.45
[Issue Type] Doxygen

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

diff --git a/include/sound_manager_internal.h b/include/sound_manager_internal.h
index a9be2b1..9705046 100644 (file)
--- a/include/sound_manager_internal.h
+++ b/include/sound_manager_internal.h
@@ -447,7 +447,7 @@ int sound_manager_add_device_id_for_stream_routing(sound_stream_info_h stream_in
  *     to get the device id.\n
  *
  * @param[in]  stream_info     The handle of stream information
- * @param[in]  device          The device id
+ * @param[in]  device_id       The device id
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -513,7 +513,7 @@ int sound_manager_set_stream_preferred_device_id(sound_stream_info_h stream_info
  *     #SOUND_STREAM_TYPE_VOICE_INFORMATION and #SOUND_STREAM_TYPE_VOICE_RECOGNITION. Otherwise, #SOUND_MANAGER_ERROR_POLICY will be returned.
  *
  * @param[in]  stream_type     The type of stream
- * @param[in]  io_direction    The IO direction of the device
+ * @param[in]  direction       The IO direction of the device
  * @param[in]  device_id       The preemptive device id (this can be #SOUND_MANAGER_STREAM_NO_PREEMPTIVE_DEVICE to unset)
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -1157,7 +1157,6 @@ int sound_manager_unpublish_local_device(void);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remarks
  * @param[in]  id The remote client id
  * @param[in]  allowed The permission to allow accessing from the remote client.
  * @return @c 0 on success,
@@ -1179,7 +1178,6 @@ int sound_manager_set_remote_permission(int id, bool allowed);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remarks
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -1197,7 +1195,6 @@ int sound_manager_start_discover_remote_device(void);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remark
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -1212,11 +1209,11 @@ int sound_manager_stop_discover_remote_device(void);
 
 /**
  * @internal
- * @brief Sets acoustic echo cancellation with a reference device
+ * @brief Sets acoustic echo cancellation reference device
  * @since_tizen 7.0
  * @remark You can get a device handle by using sound_manager_get_device_list() and sound_manager_get_next_device()
- * @param[in]  The handle of stream information
- * @param[in]  The reference device of echo-cancellation
+ * @param[in]  stream_info     The handle of stream information
+ * @param[in]  device  The reference device of echo-cancellation
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -1234,9 +1231,8 @@ int sound_manager_set_echo_cancel_reference_device(sound_stream_info_h stream_in
  * @internal
  * @brief Gets acoustic echo cancellation reference device
  * @since_tizen 7.0
- * @remark
- * @param[in]  The handle of stream information
- * @param[out] The reference device of echo-cancellation
+ * @param[in]  stream_info     The handle of stream information
+ * @param[out] device  The reference device of echo-cancellation
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -1277,6 +1273,7 @@ int sound_manager_get_rpi_playback_route(sound_rpi_playback_route_type *type);
 
 
 /**
+ * @internal
  * @brief Sets the host volume level specified for a particular sound type.
  * @since_tizen 7.0
  * @privlevel public
@@ -1293,6 +1290,7 @@ int sound_manager_get_rpi_playback_route(sound_rpi_playback_route_type *type);
 int sound_manager_set_host_volume(sound_type_e type, int volume);
 
 /**
+ * @internal
  * @brief Gets the host volume level specified for a particular sound type.
  * @since_tizen 7.0
  * @param[in]  type    The sound type

diff --git a/include/sound_manager_internal_tv.h b/include/sound_manager_internal_tv.h
index 0195d2a..d188c08 100644 (file)
--- a/include/sound_manager_internal_tv.h
+++ b/include/sound_manager_internal_tv.h
@@ -402,7 +402,7 @@ int sound_manager_add_device_id_for_stream_routing(sound_stream_info_h stream_in
  *     to get the device id.\n
  *
  * @param[in]  stream_info     The handle of stream information
- * @param[in]  device          The device id
+ * @param[in]  device_id       The device id
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -468,7 +468,7 @@ int sound_manager_set_stream_preferred_device_id(sound_stream_info_h stream_info
  *     #SOUND_STREAM_TYPE_VOICE_INFORMATION and #SOUND_STREAM_TYPE_VOICE_RECOGNITION. Otherwise, #SOUND_MANAGER_ERROR_POLICY will be returned.
  *
  * @param[in]  stream_type     The type of stream
- * @param[in]  io_direction    The IO direction of the device
+ * @param[in]  direction       The IO direction of the device
  * @param[in]  device_id       The preemptive device id (this can be #SOUND_MANAGER_STREAM_NO_PREEMPTIVE_DEVICE to unset)
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -1112,7 +1112,6 @@ int sound_manager_unpublish_local_device(void);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remarks
  * @param[in]  id The remote client id
  * @param[in]  allowed The permission to allow accessing from the remote client.
  * @return @c 0 on success,
@@ -1134,7 +1133,6 @@ int sound_manager_set_remote_permission(int id, bool allowed);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remarks
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -1152,7 +1150,6 @@ int sound_manager_start_discover_remote_device(void);
  * @since_tizen 6.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
- * @remark
  * @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 3567f8b..e306a54 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.44
+Version:    0.6.45
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0