Reinforce API documents

Change-Id: I5e3bb3df1a71aeae5ddb3e41324f238f30d5c721
Signed-off-by: Dohyun Pyun <dh79.pyun@samsung.com>

diff --git a/include/telephony_call.h b/include/telephony_call.h
index e8bb93d1a1571611a42018cb615ba2f739f963ac..64b0bf24e0fa98cd8a667b538eab3b4d2abfdee1 100644 (file)
--- a/include/telephony_call.h
+++ b/include/telephony_call.h
@@ -87,6 +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.
+ *         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.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -109,6 +112,12 @@ int telephony_call_get_preferred_voice_subscription(telephony_h handle, telephon
 
 /**
  * @brief Gets the list of the current call.
+ * @details This function is used to retrieve the list of active calls in progress.
+ *          It takes the telephony handle as input and returns the number of existing
+ *          calls along with their details. By calling this API, you can get an overview
+ *          of all ongoing calls associated with your application's telephony session.
+ *          However, it should be noted that the returned call list needs to be released
+ *          by calling the 'telephony_call_release_call_list' function.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -134,6 +143,11 @@ int telephony_call_get_call_list(telephony_h handle, unsigned int *count, teleph
 
 /**
  * @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 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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -153,6 +167,9 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call
 
 /**
  * @brief Gets the call handle ID.
+ * @details This function retrieves the unique identifier (ID) associated with a given call handle.
+ *          By utilizing this API, you can access specific attributes or perform actions related to
+ *          a particular call within your application's telephony session.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -175,6 +192,9 @@ int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *han
  * @brief Gets the call number.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @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,
+ *          you can obtain the corresponding call number.
  *
  * @remarks You must release @c number using free() on success case.
  *
@@ -195,6 +215,9 @@ int telephony_call_get_number(telephony_call_h call_handle, char **number);
 
 /**
  * @brief Gets the call type.
+ * @details This function retrieves the type of a specified call based on its handle.
+ *          Knowing the call type allows you to provide appropriate handling mechanisms
+ *          according to different scenarios.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -215,6 +238,9 @@ int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e
 
 /**
  * @brief Gets the call status.
+ * @details This function retrieves the current status of a call based on its handle.
+ *          Understanding the call status enables you to implement accurate response
+ *          mechanisms tailored to each situation.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -236,6 +262,8 @@ int telephony_call_get_status(telephony_call_h call_handle, telephony_call_statu
 /**
  * @brief Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated).
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @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[out] direction The direction of the call (#telephony_call_direction_e)
@@ -254,6 +282,11 @@ 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
+ *          adjust your application's functionality accordingly.
+ *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] call_handle The handle from #telephony_call_get_call_list()