Update API document

Change-Id: I76888ae99cb6e3935311f8980b1f4b35ace522eb
Signed-off-by: Wootak Jung <wootak.jung@samsung.com>

diff --git a/include/telephony_call.h b/include/telephony_call.h
index ff3705ab7a7e60b93d859971dffe325d189f8e36..66a4c1843b0abef3be1d8e13299bd4749556026b 100644 (file)
--- a/include/telephony_call.h
+++ b/include/telephony_call.h
@@ -87,9 +87,9 @@ typedef enum {
 
 /**
  * @brief Gets the current value for the preferred voice call subscription.
- * @detail This function is used to retrieve the current value for the preferred voice call subscription.
+ * @details This function is used to retrieve the current value for the preferred voice call subscription.
  *         It requires the handle obtained from the telephony_init() function as an argument and returns
- *         the currently set preferred call subscription value in the form of telephony_call_preferred_voice_subs_e.
+ *         the currently set preferred call subscription value in the form of #telephony_call_preferred_voice_subs_e.
  *
  * @since_tizen 2.4
  * @privlevel public
@@ -97,7 +97,7 @@ typedef enum {
  *
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] call_sub The currently set preferred call subscription value. (telephony_call_preferred_voice_subs_e)
+ * @param[out] call_sub The currently set preferred call subscription value. (#telephony_call_preferred_voice_subs_e)
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -142,17 +142,17 @@ int telephony_call_get_call_list(telephony_h handle, unsigned int *count, teleph
 
 
 /**
- * @brief Releases the list allocated from #telephony_call_get_call_list().
+ * @brief Releases the list allocated from telephony_call_get_call_list().
  * @details This function releases the memory occupied by the call list obtained through
- *          the 'telephony_call_get_call_list' API. By invoking this API, you ensure that
+ *          the telephony_call_get_call_list() API. By invoking this API, you ensure that
  *          the resources consumed by the call list are freed up, allowing them to be reused
  *          elsewhere within your application or system. Remember that before releasing the call list,
  *          it is crucial to validate its validity using the 'telephony_call_validate_call_list' function.
  *
  * @since_tizen 2.4
  *
- * @param[in] count The count of the calls from #telephony_call_get_call_list()
- * @param[in] call_list The handle from #telephony_call_get_call_list()
+ * @param[in] count The count of the calls from telephony_call_get_call_list()
+ * @param[in] call_list The handle from telephony_call_get_call_list()
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -161,7 +161,7 @@ int telephony_call_get_call_list(telephony_h handle, unsigned int *count, teleph
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call list should be validated from #telephony_call_get_call_list().
+ * @pre The call list should be validated from telephony_call_get_call_list().
  */
 int telephony_call_release_call_list(unsigned int count, telephony_call_h **call_list);
 
@@ -173,7 +173,7 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call
  *
  * @since_tizen 2.4
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] handle_id The ID of the call handle
  *
  * @return @c 0 on success,
@@ -183,8 +183,8 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *handle_id);
 
@@ -193,12 +193,12 @@ int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *han
  *
  * @since_tizen 2.4
  * @details This function retrieves the phone number associated with a specified call handle.
- *          By providing the call handle obtained from the 'telephony_call_get_call_list' API as input,
+ *          By providing the call handle obtained from the telephony_call_get_call_list() API as input,
  *          you can obtain the corresponding call number.
  *
  * @remarks You must release @c number using free() on success case.
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] number The number of the call
  *
  * @return @c 0 on success,
@@ -208,8 +208,8 @@ int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *han
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_number(telephony_call_h call_handle, char **number);
 
@@ -221,7 +221,7 @@ int telephony_call_get_number(telephony_call_h call_handle, char **number);
  *
  * @since_tizen 2.4
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] type The type of the call (#telephony_call_type_e)
  *
  * @return @c 0 on success,
@@ -231,8 +231,8 @@ int telephony_call_get_number(telephony_call_h call_handle, char **number);
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e *type);
 
@@ -244,7 +244,7 @@ int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e
  *
  * @since_tizen 2.4
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] status The status of the call (#telephony_call_status_e)
  *
  * @return @c 0 on success,
@@ -254,8 +254,8 @@ int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_status(telephony_call_h call_handle, telephony_call_status_e *status);
 
@@ -265,7 +265,7 @@ int telephony_call_get_status(telephony_call_h call_handle, telephony_call_statu
  * @details This function determines whether a call originated from the mobile device (MO)
  *          or was received by the mobile device (MT), based on the provided call handle.
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] direction The direction of the call (#telephony_call_direction_e)
  *
  * @return @c 0 on success,
@@ -275,8 +275,8 @@ int telephony_call_get_status(telephony_call_h call_handle, telephony_call_statu
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_direction_e *direction);
 
@@ -284,12 +284,12 @@ int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_di
  * @brief Gets whether the call is conference call or not.
  * @details This function checks if a call is part of a conference call or a single individual
  *          call based on the provided call handle. By fetching the required call handle using
- *          the 'telephony_call_get_call_list' API, you can determine the nature of the call and
+ *          the telephony_call_get_call_list() API, you can determine the nature of the call and
  *          adjust your application's functionality accordingly.
  *
  * @since_tizen 2.4
  *
- * @param[in] call_handle The handle from #telephony_call_get_call_list()
+ * @param[in] call_handle The handle from telephony_call_get_call_list()
  * @param[out] conference_status The value whether the call is conference call or not
  *                            (true: Conference call, false: Single call)
  *
@@ -300,8 +300,8 @@ int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_di
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list().
- * @post The call list should be released by using #telephony_call_release_call_list().
+ * @pre The call handle should be obtained from telephony_call_get_call_list().
+ * @post The call list should be released by using telephony_call_release_call_list().
  */
 int telephony_call_get_conference_status(telephony_call_h call_handle, bool *conference_status);