Fix doxygen

[platform/core/api/connection.git] / include / tv / net_connection.h

diff --git a/include/tv/net_connection.h b/include/tv/net_connection.h
index 90ab481..28d90b3 100755 (executable)
--- a/include/tv/net_connection.h
+++ b/include/tv/net_connection.h
@@ -40,21 +40,21 @@ extern "C" {
 
 /**
  * @brief The connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef void* connection_h;
 
 
 /**
  * @brief The profiles iterator handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef void* connection_profile_iterator_h;
 
 
 /**
  * @brief Enumeration for connection type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_TYPE_DISCONNECTED = 0,  /**< Disconnected */
@@ -68,7 +68,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for cellular network state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_CELLULAR_STATE_OUT_OF_SERVICE = 0,      /**< Out of service */
@@ -82,7 +82,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for Wi-Fi state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_WIFI_STATE_DEACTIVATED = 0,   /**< Wi-Fi is deactivated */
@@ -93,7 +93,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for ethernet state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  */
 typedef enum {
        CONNECTION_ETHERNET_STATE_DEACTIVATED = 0,  /**< There is no Ethernet profile to open */
@@ -104,7 +104,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for Bluetooth state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_BT_STATE_DEACTIVATED = 0,   /**< There is no Bluetooth profile to open */
@@ -115,7 +115,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for connection iterator type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_ITERATOR_TYPE_REGISTERED = 0, /**< The iterator of the registered profile */
@@ -126,7 +126,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for reset profile type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef enum {
        /**
@@ -144,7 +144,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for the attached or detached state of ethernet cable.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  */
 typedef enum {
        CONNECTION_ETHERNET_CABLE_DETACHED = 0,   /**< Ethernet cable is detached */
@@ -154,7 +154,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for connection errors.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        /**
@@ -262,7 +262,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for statistics type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        CONNECTION_STATISTICS_TYPE_LAST_RECEIVED_DATA = 0,  /**< Last received data */
@@ -288,7 +288,7 @@ typedef enum {
  * @details If you do not use this function and use other functions,
  *          you will get the #CONNECTION_ERROR_NOT_INITIALIZED error.
  *          If you put an invalid handle, you will get the #CONNECTION_ERROR_INVALID_PARAMETER error.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @remarks You must release @a connection using connection_destroy().
@@ -308,7 +308,7 @@ int connection_create(connection_h* connection);
 
 /**
  * @brief Destroys the connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -323,7 +323,7 @@ int connection_destroy(connection_h connection);
 
 /**
  * @brief Called when the type of a connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] type              The type of the current network connection
  * @param[in] user_data         The user data passed from the callback registration function
  * @see connection_set_type_changed_cb()
@@ -334,7 +334,7 @@ typedef void(*connection_type_changed_cb)(connection_type_e type, void* user_dat
 
 /**
  * @brief Called when the address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks @a ipv4_address @a ipv6_address should not be freed.
  *          @a ipv4_address @a ipv6_address is available only in the callback.
  *          To use outside the callback, make a copy.
@@ -352,7 +352,7 @@ typedef void(*connection_address_changed_cb)(const char* ipv4_address,
 
 /**
  * @brief Called when connection_set_default_cellular_service_profile_async() finishes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] result            The result
  * @param[in] user_data         The user data passed from connection_open_profile()
  * @pre connection_set_default_cellular_service_profile_async() will invoke this callback function.
@@ -376,7 +376,7 @@ typedef bool(*connection_ipv6_address_cb)(char *ipv6_address, void *user_data);
 
 /**
  * @brief Gets the type of the current profile for data connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @param[out] type             The type of the network
  * @return @c 0 on success,
@@ -392,7 +392,7 @@ int connection_get_type(connection_h connection, connection_type_e* type);
 
 /**
  * @brief Gets the IP address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks You must release @a ip_address using free().
  * @param[in] connection        The connection handle
  * @param[in] address_family    The address family
@@ -412,7 +412,7 @@ int connection_get_ip_address(connection_h connection,
 
 /**
  * @brief Gets the proxy address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks You must release @a proxy using free().
  * @param[in] connection        The connection handle
  * @param[in] address_family    The address family
@@ -432,7 +432,7 @@ int connection_get_proxy(connection_h connection,
 
 /**
  * @brief Gets the MAC address of the Wi-Fi or ethernet.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks @a mac_addr must be released with free() by you.
  * @param[in] connection        The handle of the connection
  * @param[in] type              The type of current network connection
@@ -473,7 +473,7 @@ int connection_is_metered_network(connection_h connection, bool* is_metered);
 /**
  * @brief Gets the state of cellular connection.
  * @details The returned state is for the cellular connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @param[out] state            The state of the cellular connection
  * @return @c 0 on success,
@@ -490,7 +490,7 @@ int connection_get_cellular_state(connection_h connection, connection_cellular_s
 /**
  * @brief Gets the state of the Wi-Fi.
  * @details The returned state is for the Wi-Fi connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] connection        The connection handle
@@ -510,7 +510,7 @@ int connection_get_wifi_state(connection_h connection, connection_wifi_state_e*
 /**
  * @brief Gets the state of the Ethernet.
  * @details The returned state is for the Ethernet connection state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] connection        The connection handle
@@ -529,7 +529,7 @@ int connection_get_ethernet_state(connection_h connection, connection_ethernet_s
 /**
  * @brief Checks for ethernet cable is attached or not.
  * @details The returned state is for the ethernet cable state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] connection        The handle of the connection
@@ -550,7 +550,7 @@ int connection_get_ethernet_cable_state(connection_h connection,
 /**
  * @deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb() instead.
  * @brief Called when ethernet cable is plugged [in/out].
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @param[in] state             The state of ethernet cable
  * @param[in] user_data         The user data passed to callback registration function
  */
@@ -561,7 +561,7 @@ typedef void(*connection_ethernet_cable_state_chaged_cb)
 /**
  * @deprecated Deprecated since 4.0. Use connection_set_ethernet_cable_state_changed_cb() instead.
  * @brief Sets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @param[in] connection        The connection handle
  * @param[in] callback          The callback function to be called
  * @param[in] user_data         The user data passed to the callback function
@@ -580,7 +580,7 @@ int connection_set_ethernet_cable_state_chaged_cb(connection_h connection,
 /**
  * @deprecated Deprecated since 4.0. Use connection_unset_ethernet_cable_state_changed_cb() instead.
  * @brief Unsets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @param[in] connection        The connection handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -638,7 +638,7 @@ int connection_unset_ethernet_cable_state_changed_cb(connection_h connection);
 /**
  * @brief Gets the state of the Bluetooth.
  * @details The returned state is for the Bluetooth connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] connection        The connection handle
@@ -657,7 +657,7 @@ int connection_get_bt_state(connection_h connection, connection_bt_state_e* stat
 
 /**
  * @brief Sets the callback that is called when the type of the current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @param[in] callback          The callback function to be called
  * @param[in] user_data         The user data passed to the callback function
@@ -675,7 +675,7 @@ int connection_set_type_changed_cb(connection_h connection,
 
 /**
  * @brief Unsets the callback that is called when the type of current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -690,7 +690,7 @@ int connection_unset_type_changed_cb(connection_h connection);
 
 /**
  * @brief Sets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @param[in] callback          The callback function to be called
  * @param[in] user_data         The user data passed to the callback function
@@ -708,7 +708,7 @@ int connection_set_ip_address_changed_cb(connection_h connection,
 
 /**
  * @brief Unsets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -723,7 +723,7 @@ int connection_unset_ip_address_changed_cb(connection_h connection);
 
 /**
  * @brief Sets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @param[in] callback          The callback function to be called
  * @param[in] user_data         The user data passed to the callback function
@@ -741,7 +741,7 @@ int connection_set_proxy_address_changed_cb(connection_h connection,
 
 /**
  * @brief Unsets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] connection        The connection handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -756,7 +756,7 @@ int connection_unset_proxy_address_changed_cb(connection_h connection);
 
 /**
  * @brief Adds a new profile which is created by connection_profile_create().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile
  * @remarks You can only add a profile of the cellular type.
@@ -776,7 +776,7 @@ int connection_add_profile(connection_h connection, connection_profile_h profile
 
 /**
  * @brief Removes an existing profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
@@ -802,7 +802,7 @@ int connection_remove_profile(connection_h connection, connection_profile_h prof
  *          When you call this function, your changes affect the Connection Manager
  *          and the existing profile is updated.
  *          In addition, the existing profile will be updated if you call connection_open_profile().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
@@ -824,7 +824,7 @@ int connection_update_profile(connection_h connection, connection_profile_h prof
 
 /**
  * @brief Gets a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @remarks You must release @a profile_iterator using connection_destroy().
@@ -847,7 +847,7 @@ int connection_get_profile_iterator(connection_h connection,
 
 /**
  * @brief Moves the profile iterator to the next position and gets a profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] profile_iterator  The iterator of profile
  * @param[out] profile          The profile handle
  * @return @c 0 on success,
@@ -864,7 +864,7 @@ int connection_profile_iterator_next(connection_profile_iterator_h profile_itera
 
 /**
  * @brief Checks whether the next element of a profile iterator exists or not.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks The specific error code can be obtained using the get_last_result() method.
  *          Error codes are described in Exception section.
  * @param[in] profile_iterator  The iterator of profile
@@ -880,7 +880,7 @@ bool connection_profile_iterator_has_next(connection_profile_iterator_h profile_
 
 /**
  * @brief Destroys a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] profile_iterator  The iterator of the profile
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -894,7 +894,7 @@ int connection_destroy_profile_iterator(connection_profile_iterator_h profile_it
 
 /**
  * @brief Gets the name of the default profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @remarks You must release @a profile using connection_profile_destroy().
@@ -916,7 +916,7 @@ int connection_get_current_profile(connection_h connection, connection_profile_h
 
 /**
  * @brief Gets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @remarks You must release @a profile using connection_profile_destroy().
@@ -940,7 +940,7 @@ int connection_get_default_cellular_service_profile(connection_h connection,
 
 /**
  * @brief Sets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
@@ -965,7 +965,7 @@ int connection_set_default_cellular_service_profile(connection_h connection,
 
 /**
  * @brief Sets the default profile which provides the given cellular service, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *               %http://tizen.org/privilege/network.get
@@ -993,7 +993,7 @@ int connection_set_default_cellular_service_profile_async(connection_h connectio
 
 /**
  * @brief Called after connection_open_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] result            The result
  * @param[in] user_data         The user data passed from connection_open_profile()
  * @pre connection_open_profile() will invoke this callback function.
@@ -1004,7 +1004,7 @@ typedef void(*connection_opened_cb)(connection_error_e result, void* user_data);
 
 /**
  * @brief Called after connection_close_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] result            The result
  * @param[in] user_data         The user data passed from connection_close_profile()
  * @pre connection_close_profile() will invoke this callback function.
@@ -1015,7 +1015,7 @@ typedef void(*connection_closed_cb)(connection_error_e result, void* user_data);
 
 /**
  * @brief Called after connection_reset_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] result            The result
  * @param[in] user_data         The user data passed from connection_reset_profile()
  * @pre connection_reset_profile() will invoke this callback function.
@@ -1026,7 +1026,7 @@ typedef void(*connection_reset_cb)(connection_error_e result, void* user_data);
 
 /**
  * @brief Opens a connection of profile, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
@@ -1056,7 +1056,7 @@ int connection_open_profile(connection_h connection, connection_profile_h profil
 
 /**
  * @brief Closes a connection of profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set
  * @param[in] connection        The connection handle
@@ -1084,7 +1084,7 @@ int connection_close_profile(connection_h connection, connection_profile_h profi
 
 /**
  * @brief Resets the cellular profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *               %http://tizen.org/privilege/network.get
@@ -1115,7 +1115,7 @@ int connection_reset_profile(connection_h connection, connection_reset_option_e
  * @brief Adds a IPv4 route to the routing table.
  * @details You can get the @a interface_name from
  *          connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel partner
  * @privilege %http://tizen.org/privilege/network.route
  * @remarks Since 6.0, the required privilege and level of this function has changed.
@@ -1143,7 +1143,7 @@ int connection_add_route(connection_h connection, const char* interface_name,
  * @brief Removes a IPv4 route from the routing table.
  * @details You can get the @a interface_name from
  *          connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel partner
  * @privilege %http://tizen.org/privilege/network.route
  * @remarks Since 6.0, the required privilege and level of this function has changed.
@@ -1311,7 +1311,7 @@ int connection_foreach_ipv6_address(connection_h connection, connection_type_e c
 
 /**
  * @brief Gets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] connection The connection handle
@@ -1334,7 +1334,7 @@ int connection_get_statistics(connection_h connection, connection_type_e connect
 
 /**
  * @brief Resets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set
  * @param[in] connection        The connection handle