From ac1693a569fcf7327d8ba0d6a829cc7b551f08a5 Mon Sep 17 00:00:00 2001 From: Jaemin Ahn Date: Wed, 27 Mar 2013 11:51:15 +0900 Subject: [PATCH 1/1] [Doxygen] Add @feature key on the doxygen. Change-Id: I0276be4cc84b0360a6e1b41407ca3242df8cb8c6 Signed-off-by: Jaemin Ahn --- inc/FNetNetAccountManager.h | 59 ++++++++++++++++++++++++++++-------------- inc/FNetNetConnectionManager.h | 8 ++++-- inc/FNetNetStatistics.h | 24 ++++++++++++----- 3 files changed, 63 insertions(+), 28 deletions(-) diff --git a/inc/FNetNetAccountManager.h b/inc/FNetNetAccountManager.h index 8a84509..7a3928e 100644 --- a/inc/FNetNetAccountManager.h +++ b/inc/FNetNetAccountManager.h @@ -88,6 +88,7 @@ public: * * @privlevel public * @privilege %http://tizen.org/privilege/network.account + * @feature %http://tizen.org/feature/network.telephony * * @return The @c NetAccountId assigned by the creation of a new network account, @n * else @c INVALID_HANDLE if an error occurs @@ -98,10 +99,13 @@ public: * @exception E_MAX_EXCEEDED The registry is full. @n Cannot create a new network account. * @exception E_SYSTEM An internal error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The device does not support the telephony feature. @b Since: @b 2.1 - * @remarks This method creates a new network account and returns a @c NetAccountId value that can be used in method calls later to operate on the - * account. If @c INVALID_HANDLE is returned, the specific error code can be accessed using the GetLastResult() method. A Wi-Fi account - * cannot be created using %NetAccountManager. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - This method creates a new network account and returns a @c NetAccountId value that can be used in method calls later to operate on the + * account. If @c INVALID_HANDLE is returned, the specific error code can be accessed using the GetLastResult() method. A Wi-Fi account + * cannot be created using %NetAccountManager. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @see GetNetAccountInfoN() * @see UpdateNetAccount() * @see DeleteNetAccount() @@ -139,6 +143,7 @@ public: * * @privlevel public * @privilege %http://tizen.org/privilege/network.account + * @feature %http://tizen.org/feature/network.telephony * * @return An error code * @param[in] netAccountInfo A NetAccountInfo instance containing network information to update an account @@ -149,12 +154,13 @@ public: * @exception E_SYSTEM An internal error has occurred. * @exception E_INVALID_OPERATION This operation is not allowed on this network account instance. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The device does not support the telephony feature. @b Since: @b 2.1 - * @remarks This method fails if the network account is read-only, in service, or created by another application. - * A Wi-Fi account cannot be updated using %NetAccountManager. - * Before calling this method, the user must call GetNetAccountInfoN() to get the latest information in the registry - * and change the desired fields of that information. - * This method must use a warning pop-up to notify the user. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - This method fails if the network account is read-only, in service, or created by another application. + * A Wi-Fi account cannot be updated using %NetAccountManager. + * This method must use a warning pop-up to notify the user. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @see CreateNetAccount() * @see GetNetAccountInfoN() * @see UpdateNetAccount() @@ -169,6 +175,7 @@ public: * * @privlevel platform * @privilege %http://tizen.org/privilege/networkmanager + * @feature %http://tizen.org/feature/network.telephony or %http://tizen.org/feature/network.telephony.mms * * @return An error code * @param[in] netAccountInfo A NetAccountInfo instance containing network information to update an account @@ -177,7 +184,9 @@ public: * @exception E_INVALID_ACCOUNT The input account ID is invalid. * @exception E_OPERATION_FAILED This request operation has failed due to an internal error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The device does not support the telephony or MMS feature. @b Since: @b 2.1 + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @see GetNetAccountInfoN() * @see UpdateNetAccount() */ @@ -257,15 +266,18 @@ public: * * @since 2.0 * + * @feature %http://tizen.org/feature/network.telephony, %http://tizen.org/feature/network.telephony.mms, %http://tizen.org/feature/network.wifi, %http://tizen.org/feature/network.wifi.direct, or %http://tizen.org/feature/usb.host + * * @return The network account, @n * else INVALID_HANDLE in case of an error or if NetAccountInfo is not found * @param[in] netBearerType The network account type of bearer * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM An internal error has occurred (baseband). - * @exception E_UNSUPPORTED_OPERATION The specified @c netBearerType is not supported by this device. @b Since: @b 2.1 - * @remarks The specific error code can be accessed using the GetLastResult() method. - * If INVALID_HANDLE is returned but the last result shows success, @n - * show a pop-up that asks the user to select the network profile in the Settings menu. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. */ NetAccountId GetNetAccountId(NetBearerType netBearerType = NET_BEARER_PS) const; @@ -276,6 +288,7 @@ public: * * @privlevel partner * @privilege %http://tizen.org/privilege/customnetaccount + * @feature %http://tizen.org/feature/network.telephony or %http://tizen.org/feature/network.telephony.mms * * @return The @c NetAccountID with the specified name, @n * else INVALID_HANDLE is returned in case of an error or if %NetAccountInfo is not found @@ -284,8 +297,11 @@ public: * @exception E_INVALID_ARG The @c netAccountName is invalid or %NetAccountInfo with this name does not exist. * @exception E_SYSTEM An internal error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c netProfileName is not supported by this device. @b Since: @b 2.1 - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. */ NetAccountId GetAppNetAccountId(const Tizen::Base::String& netProfileName) const; @@ -332,15 +348,18 @@ public: * * @privlevel public * @privilege %http://tizen.org/privilege/network.connection + * @feature %http://tizen.org/feature/network.wifi or %http://tizen.org/feature/network.telephony * * @return An error code * @param[in] netPreference The preferred network * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION This operation is not allowed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c netPreference is not supported by this device. @b Since: @b 2.1 - * @remarks This preference is not changed during the application life-cycle. - * If this method is not used, the default connection works in the Wi-Fi first mode. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - If this method is not used, the default connection works in the Wi-Fi first mode. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @endif */ result SetNetPreference(NetPreferenceType netPreference = NET_WIFI_FIRST); diff --git a/inc/FNetNetConnectionManager.h b/inc/FNetNetConnectionManager.h index ccbee49..7bcef2d 100644 --- a/inc/FNetNetConnectionManager.h +++ b/inc/FNetNetConnectionManager.h @@ -124,14 +124,18 @@ public: * * @privlevel public * @privilege %http://tizen.org/privilege/network.connection + * @feature %http://tizen.org/feature/network.wifi or %http://tizen.org/feature/network.telephony * * @return An error code * @param[in] netPreference The preferred network * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION This operation is not allowed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c netPreference is not supported by this device. @b Since: @b 2.1 - * @remarks If this method is not used, the default connection works in the Wi-Fi first mode. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - If this method is not used, the default connection works in the Wi-Fi first mode. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. */ result SetNetPreference(NetPreferenceType netPreference); diff --git a/inc/FNetNetStatistics.h b/inc/FNetNetStatistics.h index 9761076..5ef4639 100755 --- a/inc/FNetNetStatistics.h +++ b/inc/FNetNetStatistics.h @@ -85,6 +85,7 @@ public: * * @privlevel public * @privilege %http://tizen.org/privilege/network.statistics + * @feature %http://tizen.org/feature/network.wifi or %http://tizen.org/feature/network.telephony * * @return The number of bytes sent or received, @n * else @c INVALID_HANDLE if an error occurs @@ -94,8 +95,11 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c bearerType is not supported by this device. @b Since: @b 2.1 - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. */ long long GetNetStatisticsInfo(NetBearerType bearerType, NetStatisticsInfoType netStatType) const; @@ -106,6 +110,7 @@ public: * * @privlevel platform * @privilege %http://tizen.org/privilege/netstatisticsmanager + * @feature %http://tizen.org/feature/network.wifi or %http://tizen.org/feature/network.telephony * * @return An error code * @param[in] bearerType The bearer type (OperationMode) whose statistical information is reset @n NET_BEARER_WIFI_DIRECT and NET_BEARER_USB are not supported. @@ -114,8 +119,11 @@ public: * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM An internal error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c bearerType is not supported by this device. @b Since: @b 2.1 - * @remarks This method must use warning pop-up for user notification. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - This method must use warning pop-up for user notification. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @see GetNetStatisticsInfo() */ result Reset(NetBearerType bearerType, NetStatisticsInfoType netStatType); @@ -127,6 +135,7 @@ public: * * @privlevel platform * @privilege %http://tizen.org/privilege/netstatisticsmanager + * @feature %http://tizen.org/feature/network.wifi or %http://tizen.org/feature/network.telephony * * @return An error code * @param[in] bearerType The bearer type (OperationMode) whose statistical information would be reset @n NET_BEARER_WIFI_DIRECT and NET_BEARER_USB are not supported. @@ -134,8 +143,11 @@ public: * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_SYSTEM An internal error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The specified @c bearerType is not supported by this device. @b Since: @b 2.1 - * @remarks This method must use warning pop-up for user notification. + * @exception E_UNSUPPORTED_OPERATION The target device does not support the required feature. @b Since: @b 2.1 + * For more information, see Application Filtering. + * @remarks + * - This method must use warning pop-up for user notification. + * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods. * @see GetNetStatisticsInfo() */ result ResetAll(NetBearerType bearerType); -- 2.7.4