Update @since_tizen doxygen tag due to profile merge 15/302315/1 accepted/tizen_unified accepted/tizen_unified_dev accepted/tizen_unified_riscv tizen accepted/tizen/unified/20231211.171506 accepted/tizen/unified/dev/20240620.004516 accepted/tizen/unified/riscv/20231226.211051
authorSeungbae Shin <seungbae.shin@samsung.com>
Tue, 5 Dec 2023 08:20:29 +0000 (17:20 +0900)
committerSeungbae Shin <seungbae.shin@samsung.com>
Tue, 5 Dec 2023 08:20:29 +0000 (17:20 +0900)
[Version] 0.7.11
[Issue Type] Doxygen

Change-Id: I3d7c45c5c40475d158929542e4b37d129f195090

include/sound_manager.h
packaging/capi-media-sound-manager.spec

index 25b4063..0a09b8f 100644 (file)
@@ -36,7 +36,7 @@ extern "C"
 
 /**
  * @brief Enumeration for sound manager's error codes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        SOUND_MANAGER_ERROR_NONE              = TIZEN_ERROR_NONE,                    /**< Successful */
@@ -59,16 +59,16 @@ typedef enum {
 
 /**
  * @brief Enumeration for sound type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        SOUND_TYPE_SYSTEM,          /**< Sound type for system */
        SOUND_TYPE_NOTIFICATION,    /**< Sound type for notifications */
        SOUND_TYPE_ALARM,           /**< Sound type for alarm */
-       SOUND_TYPE_RINGTONE,        /**< Sound type for ringtones (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
+       SOUND_TYPE_RINGTONE,        /**< Sound type for ringtones (Since 2.4) */
        SOUND_TYPE_MEDIA,           /**< Sound type for media */
-       SOUND_TYPE_CALL,            /**< Sound type for call (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
-       SOUND_TYPE_VOIP,            /**< Sound type for voip (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
+       SOUND_TYPE_CALL,            /**< Sound type for call (Since 2.4) */
+       SOUND_TYPE_VOIP,            /**< Sound type for voip (Since 2.4) */
        SOUND_TYPE_VOICE,           /**< Sound type for voice */
 } sound_type_e;
 
@@ -178,19 +178,19 @@ typedef enum {
 
 /**
  * @brief Sound device handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef void* sound_device_h;
 
 /**
  * @brief Sound device list handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef void* sound_device_list_h;
 
 /**
 * @brief Enumeration for sound device type.
-* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+* @since_tizen 2.3
 */
 typedef enum {
        SOUND_DEVICE_BUILTIN_SPEAKER,   /**< Built-in speaker */
@@ -207,7 +207,7 @@ typedef enum {
 
 /**
 * @brief Enumeration for sound device direction.
-* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+* @since_tizen 2.3
 */
 typedef enum {
        SOUND_DEVICE_IO_DIRECTION_IN,   /**< Input device */
@@ -218,7 +218,7 @@ typedef enum {
 
 /**
 * @brief Enumeration for sound device mask.
-* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+* @since_tizen 2.3
 */
 typedef enum {
        SOUND_DEVICE_IO_DIRECTION_IN_MASK      = 0x0001,  /**< Mask for input devices */
@@ -294,7 +294,7 @@ typedef enum {
 
 /**
  * @brief Called when the system volume has changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]   type   The sound type of the changed volume
  * @param[in]   volume The new volume value
  * @param[in]   user_data      The user data passed from the callback registration function
@@ -426,7 +426,7 @@ typedef void (*sound_device_running_changed_cb) (sound_device_h device, bool is_
 
 /**
  * @brief Gets the maximum volume level supported for a particular sound type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]          type The sound type
  * @param[out] max     The maximum volume level
  * @return @c 0 on success,
@@ -440,7 +440,7 @@ int sound_manager_get_max_volume(sound_type_e type, int *max);
 
 /**
  * @brief Sets the volume level specified for a particular sound type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/volume.set
  * @param[in]          type The sound type
@@ -458,7 +458,7 @@ int sound_manager_set_volume(sound_type_e type, int volume);
 
 /**
  * @brief Gets the volume level specified for a particular sound type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]          type The sound type
  * @param[out] volume  The current volume level
  * @return @c 0 on success,
@@ -473,7 +473,7 @@ int sound_manager_get_volume(sound_type_e type, int *volume);
 
 /**
  * @brief Gets the type of the sound being currently played.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[out] type The current sound type
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -1236,7 +1236,7 @@ int sound_manager_free_device_list(sound_device_list_h device_list);
 
 /**
  * @brief Gets the next item of the device list.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device_list     The list of connected devices
  * @param[out] device  The device item
  * @return @c 0 on success,
@@ -1257,7 +1257,7 @@ int sound_manager_get_next_device(sound_device_list_h device_list, sound_device_
 
 /**
  * @brief Gets the previous item of the device list.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device_list     The list of connected devices
  * @param[out] device  The device item
  * @return @c 0 on success,
@@ -1278,7 +1278,7 @@ int sound_manager_get_prev_device(sound_device_list_h device_list, sound_device_
 
 /**
  * @brief Gets the type of the device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device  The device item
  * @param[out] type    The type of the device
  * @return @c 0 on success,
@@ -1298,7 +1298,7 @@ int sound_manager_get_device_type(sound_device_h device, sound_device_type_e *ty
 
 /**
  * @brief Gets the io direction of the device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device  The device item
  * @param[out] io_direction    The io direction of the device
  * @return @c 0 on success,
@@ -1318,7 +1318,7 @@ int sound_manager_get_device_io_direction(sound_device_h device, sound_device_io
 
 /**
  * @brief Gets the id of the device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device  The device item
  * @param[out] id      The id of the device
  * @return @c 0 on success,
@@ -1338,7 +1338,7 @@ int sound_manager_get_device_id(sound_device_h device, int *id);
 
 /**
  * @brief Gets the name of the device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in]  device  The device item
  * @param[out] name    The name of the device
  * @return @c 0 on success,
index a7556d8..9e9113f 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-sound-manager
 Summary:    Sound Manager library
-Version:    0.7.10
+Version:    0.7.11
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0