Fix mistakes in header description

[Version] 0.1.10
[Profile] Mobile, Wearable
[Issue Type] Fix doc bugs

Change-Id: I55d6145a2a69d2d1197a4eb866f227b5e74d8c55

diff --git a/include/radio.h b/include/radio.h
index 4768ad4..fc70d1f 100755 (executable)
--- a/include/radio.h
+++ b/include/radio.h
@@ -85,7 +85,7 @@ typedef enum {
 /**
  * @brief  Called when the scan information is updated.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] frequency The tuned radio frequency [87500 ~ 108000] (kHz)
+ * @param[in] frequency  The tuned radio frequency [87500 ~ 108000] (kHz)
  * @param[in] user_data  The user data passed from the callback registration function
  * @pre It will be invoked by radio_scan_start().
  * @see radio_scan_start()
@@ -115,7 +115,7 @@ typedef void (*radio_scan_completed_cb)(void *user_data);
 /**
  * @brief  Called when the radio seek is completed.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] frequency The current frequency [87500 ~ 108000] (kHz)
+ * @param[in] frequency  The current frequency [87500 ~ 108000] (kHz)
  * @param[in] user_data  The user data passed from the callback registration function
  * @pre It will be invoked when the radio seek is completed by registering this callback using radio_seek_up() or radio_seek_down().
  * @see radio_seek_up()
@@ -126,8 +126,8 @@ typedef void (*radio_seek_completed_cb)(int frequency, void *user_data);
 /**
  * @brief  Called when the radio is interrupted.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]  error_code      The interrupted error code
- * @param[in]  user_data       The user data passed from the callback registration function
+ * @param[in] code      The interrupted error code
+ * @param[in] user_data The user data passed from the callback registration function
  * @see radio_set_interrupted_cb()
  * @see radio_unset_interrupted_cb()
  */
@@ -137,7 +137,9 @@ typedef void (*radio_interrupted_cb)(radio_interrupted_code_e code, void *user_d
  * @brief Creates a radio handle.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks You must release @a radio using radio_destroy().
- * @param[out]  radio  A new handle to radio
+ * @param[out] radio A new handle to radio
+ * @return @c 0 on success,
+ *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
  * @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #RADIO_ERROR_OUT_OF_MEMORY Out of memory
@@ -152,7 +154,7 @@ int radio_create(radio_h *radio);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks To completely shutdown the radio operation, call this function with a valid radio handle.
  *
- * @param[in]          radio The handle to radio to be destroyed
+ * @param[in] radio The handle to radio to be destroyed
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -166,8 +168,8 @@ int radio_destroy(radio_h radio);
 /**
  * @brief Gets the radio's current state.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio  The handle to radio
- * @param[out]  state  The current state of the radio
+ * @param[in]  radio The handle to radio
+ * @param[out] state The current state of the radio
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -179,7 +181,7 @@ int  radio_get_state(radio_h radio, radio_state_e *state);
 /**
  * @brief Starts playing the radio.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
+ * @param[in] radio The handle to radio
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -197,7 +199,7 @@ int radio_start(radio_h radio);
 /**
  * @brief Stops playing the radio.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
+ * @param[in] radio The handle to radio
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -214,9 +216,9 @@ int radio_stop(radio_h radio);
 /**
  * @brief Seeks up the effective frequency of the radio, asynchronously.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -233,9 +235,9 @@ int radio_seek_up(radio_h radio, radio_seek_completed_cb callback, void *user_da
 /**
  * @brief Seeks down the effective frequency of the radio, asynchronously.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -252,8 +254,8 @@ int radio_seek_down(radio_h radio, radio_seek_completed_cb callback, void *user_
 /**
  * @brief Sets the radio frequency.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[in]   frequency The frequency to set [87500 ~ 108000] (kHz)
+ * @param[in] radio     The handle to radio
+ * @param[in] frequency The frequency to set [87500 ~ 108000] (kHz)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -267,8 +269,8 @@ int radio_set_frequency(radio_h radio, int frequency);
 /**
  * @brief Gets the current frequency of the radio.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[out]  frequency The current frequency [87500 ~ 108000] (kHz)
+ * @param[in]  radio     The handle to radio
+ * @param[out] frequency The current frequency [87500 ~ 108000] (kHz)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -282,8 +284,8 @@ int radio_get_frequency(radio_h radio, int *frequency);
 /**
  * @brief Gets the current signal strength of the radio.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[out]  strength The current signal strength [-128 ~ 128] (dBm)
+ * @param[in]  radio    The handle to radio
+ * @param[out] strength The current signal strength [-128 ~ 128] (dBm)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -294,11 +296,11 @@ int radio_get_frequency(radio_h radio, int *frequency);
 int radio_get_signal_strength(radio_h radio, int *strength);
 
 /**
- * @brief Starts scanning radio signals, asynchronously
+ * @brief Starts scanning radio signals, asynchronously.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -319,9 +321,9 @@ int radio_scan_start(radio_h radio, radio_scan_updated_cb callback, void *user_d
 /**
  * @brief Stops scanning radio signals, asynchronously.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in]   radio The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -338,10 +340,10 @@ int radio_scan_stop(radio_h radio, radio_scan_stopped_cb callback, void *user_da
 
 /**
  * @brief Sets the radio's mute status.
+ * @details If the mute status is @c true, no sounds will be played. If @c false, sounds will be played. Until this function is called, by default the radio is not muted.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @details  If the mute status is @c true, no sounds will be played. If @c false, sounds will be played. Until this function is called, by default the radio is not muted.
- * @param[in]   radio The handle to radio
- * @param[in]   muted The new mute status: (@c true = mute, @c false = not muted)
+ * @param[in] radio The handle to radio
+ * @param[in] muted The new mute status: (@c true = mute, @c false = not muted)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -354,10 +356,10 @@ int radio_set_mute(radio_h radio, bool muted);
 
 /**
  * @brief Gets the radio's mute status.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @details If the mute status is @c true, no sounds are played. If @c false, sounds are played.
- * @param[in]   radio The handle to radio
- * @param[out]  muted  The current mute status: (@c true = mute, @c false = not muted)
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @param[in]  radio The handle to radio
+ * @param[out] muted The current mute status: (@c true = mute, @c false = not muted)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -369,11 +371,11 @@ int radio_set_mute(radio_h radio, bool muted);
 int radio_is_muted(radio_h radio, bool *muted);
 
 /**
- * @brief Registers a callback function to be invoked when the scan finishes.
+ * @brief Sets a callback function to be invoked when the scan finishes.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio    The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -387,7 +389,7 @@ int radio_is_muted(radio_h radio, bool *muted);
 int radio_set_scan_completed_cb(radio_h radio, radio_scan_completed_cb callback, void *user_data);
 
 /**
- * @brief      Unregisters the callback function.
+ * @brief Unsets the scan completed callback function.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] radio The handle to radio
  * @return @c 0 on success,
@@ -401,11 +403,11 @@ int radio_set_scan_completed_cb(radio_h radio, radio_scan_completed_cb callback,
 int radio_unset_scan_completed_cb(radio_h radio);
 
 /**
- * @brief Registers a callback function to be invoked when the radio is interrupted.
+ * @brief Sets a callback function to be invoked when the radio is interrupted.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio    The handle to radio
- * @param[in] callback The callback function to register
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] radio     The handle to radio
+ * @param[in] callback  The callback function to register
+ * @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 #RADIO_ERROR_NONE Successful
@@ -420,7 +422,7 @@ int radio_unset_scan_completed_cb(radio_h radio);
 int radio_set_interrupted_cb(radio_h radio, radio_interrupted_cb callback, void *user_data);
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the interrupted callback function.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] radio The handle to radio
  * @return @c 0 on success,
@@ -436,9 +438,9 @@ int radio_unset_interrupted_cb(radio_h radio);
 /**
  * @brief Gets the min, max frequency of the region.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param[in]   radio The handle to radio
- * @param[out]  min_freq The min frequency [87500 ~ 108000] (kHz)
- * @param[out]  max_freq The max frequency [87500 ~ 108000] (kHz)
+ * @param[in]  radio    The handle to radio
+ * @param[out] min_freq The min frequency [87500 ~ 108000] (kHz)
+ * @param[out] max_freq The max frequency [87500 ~ 108000] (kHz)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -451,7 +453,7 @@ int radio_get_frequency_range(radio_h radio, int *min_freq, int *max_freq);
 /**
  * @brief Gets channel spacing.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param[in]   radio The handle to radio
+ * @param[in]   radio           The handle to radio
  * @param[out]  channel_spacing The channel spacing value
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -469,8 +471,8 @@ int radio_get_channel_spacing(radio_h radio, int *channel_spacing);
  *           To change system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API.
  *           Finally, it does not support to set other value into each channel currently.
  * @since_tizen 3.0
- * @param[in]   radio The handle to radio
- * @param[in]   volume The volume to set [0.0 ~ 1.0](1.0 = 100%)
+ * @param[in] radio  The handle to radio
+ * @param[in] volume The volume to set [0.0 ~ 1.0](1.0 = 100%)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful
@@ -487,8 +489,8 @@ int radio_set_volume(radio_h radio, float volume);
  *          This function gets the radio volume, not the system volume.
  *          To get the system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API.
  * @since_tizen 3.0
- * @param[in]   radio The handle to radio
- * @param[out]  volume The current volume [0.0 ~ 1.0](1.0 = 100%)
+ * @param[in]  radio  The handle to radio
+ * @param[out] volume The current volume [0.0 ~ 1.0](1.0 = 100%)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #RADIO_ERROR_NONE Successful

diff --git a/packaging/capi-media-radio.spec b/packaging/capi-media-radio.spec
index 8b711c3..a01f198 100644 (file)
--- a/packaging/capi-media-radio.spec
+++ b/packaging/capi-media-radio.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-radio
 Summary:    A Radio library in Tizen Native API
-Version:    0.1.9
+Version:    0.1.10
 Release:    1
 Group:      API/C API
 License:    Apache-2.0