X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=inc%2FFSysDeviceManager.h;h=9e0441b5b62da2765f6a89f289b554d6140ad6fb;hb=9646d95c0666d24d94fdefeedf94c951b9d6c812;hp=85ce0559ffc657e05d4e8a40a6abb5523eec70df;hpb=27f1388665067f69d5eb64e0cae6bb5f4250beec;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSysDeviceManager.h b/inc/FSysDeviceManager.h index 85ce055..9e0441b 100644 --- a/inc/FSysDeviceManager.h +++ b/inc/FSysDeviceManager.h @@ -69,9 +69,8 @@ enum DeviceType * * @final This class is not intended for extension. * - * The %DeviceManager class provides listener to handle events for various external device, - * such as a Bluetooth headset, HDMI, and headphone. - * This class also gets the current state of the device. You cannot create an instance of this class directly. + * The %DeviceManager class provides listeners to handle events for various external device, such as a Bluetooth headset, HDMI, + * and headphone. This class also gets the current state of the device. You cannot create an instance of this class directly. * * For more information on the class features, see External Device Management. * @@ -89,19 +88,19 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n - * For more information, see @ref DeviceManagerGetStatePage "here". + * For more information, see @ref DeviceManagerGetStatePage "here". * @endif * * @param[in] deviceType The value from the enumerator DeviceType indicating the device * @param[out] state The device state of type Tizen::Base::String * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result GetState(DeviceType deviceType, Tizen::Base::String& state); @@ -111,31 +110,31 @@ public: * @page DeviceManagerGetStatePage Compatibility for GetState() * @section DeviceManagerGetStatePageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * The GetState() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * The GetState() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerGetStatePageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Adds a device event listener. + * Adds the device event listener. * * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n * For more information, see @ref DeviceManagerAddDeviceEventListenerPage "here". * @endif * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. + * @return An error code + * @param[in] deviceType The device type + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result AddDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -145,24 +144,24 @@ public: * @page DeviceManagerAddDeviceEventListenerPage Compatibility for AddDeviceEventListener() * @section DeviceManagerAddDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This AddDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This AddDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerAddDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes a device event listener from all types of devices. + * Removes the device event listener from all types of devices. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. + * @return An error code + * @param[in] deviceType The types of a device + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result RemoveDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -172,18 +171,18 @@ public: * @page DeviceManagerRemoveDeviceEventListenerPage Compatibility for RemoveDeviceEventListener() * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This RemoveDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This RemoveDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes all device event listeners. + * Removes all the device event listeners. * - * @since 2.0 + * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */