From: Joonho Cho Date: Wed, 20 Mar 2013 06:39:10 +0000 (+0900) Subject: some modification such as aligning X-Git-Tag: 2.1b_release~12 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a7dacf713d7966929cc4de598c5fefd01c2a1e81;p=platform%2Fframework%2Fnative%2Fbluetooth.git some modification such as aligning Change-Id: I0633211abe74e866e0a3d2695741cee619c45528 Signed-off-by: Joonho Cho --- diff --git a/inc/FNetBtBluetoothDevice.h b/inc/FNetBtBluetoothDevice.h index b6668b4..19cec96 100755 --- a/inc/FNetBtBluetoothDevice.h +++ b/inc/FNetBtBluetoothDevice.h @@ -123,10 +123,10 @@ public: * * @return An error code * @param[in] address An address of the %Bluetooth device - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified address is invalid. @n - * The size of the address should be @c 6 bytes. - * @remarks Setting the address of the %BluetoothDevice instance which is obtained from the paired list does not + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified address is invalid. @n + * The size of the address should be @c 6 bytes. + * @remarks Setting the address of the %BluetoothDevice instance which is obtained from the paired list does not * affect the information of the paired list in the system. */ result SetAddress(const Tizen::Base::ByteBuffer& address); diff --git a/inc/FNetBtBluetoothHealth.h b/inc/FNetBtBluetoothHealth.h index 47040ad..5b7fd26 100755 --- a/inc/FNetBtBluetoothHealth.h +++ b/inc/FNetBtBluetoothHealth.h @@ -83,19 +83,19 @@ public: * * @return An error code * @param[in] listener The event listener for the %BluetoothHealth. @n - * The specified listener must be allocated at heap, not stack. + * The specified listener must be allocated at heap, not stack. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION The device does not support the %Bluetooth feature. + * @exception E_UNSUPPORTED_OPERATION The device does not support the %Bluetooth feature. * @exception E_OPERATION_FAILED The method has failed. */ result Construct(IBluetoothHealthEventListener& listener); /** * Starts %Bluetooth health as a role of sink with the specified data type. @n - * One %BluetoothHealth instance supports only a sink role with the specific data type at one time and - * only one sink role for the specific data type can be enabled system-widely. @n - * For providing sink roles with various data types, make multiple %BluetoothHealth instances with different data types. + * One %BluetoothHealth instance supports only a sink role with the specific data type at one time and only one + * sink role for the specific data type can be enabled system-widely. @n + * For providing sink roles with various data types, make multiple %BluetoothHealth instances with different data types. * * @since 2.0 * @privlevel public @@ -172,8 +172,8 @@ public: * * @return An error code * @param[in] channelId The ID of the specified channel to disconnect. @n - * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the - * specific channel is established. + * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() + * after the specific channel is established. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE %Bluetooth is not activated. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified @@ -193,8 +193,8 @@ public: * * @return An error code * @param[in] channelId The ID of the specified channel on which the data is sent. @n - * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the - * specific channel is established. + * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() + * after the specific channel is established. * @param[in] buffer The data to send * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE %Bluetooth is not activated. diff --git a/inc/FNetBtBluetoothManager.h b/inc/FNetBtBluetoothManager.h index ebb91ef..631dab0 100755 --- a/inc/FNetBtBluetoothManager.h +++ b/inc/FNetBtBluetoothManager.h @@ -87,7 +87,7 @@ public: * @param[in] listener The listener to handle the %BluetoothManager event * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. */ result Construct(IBluetoothManagerEventListener& listener); @@ -177,8 +177,8 @@ public: * @since 2.0 * * @return The local %Bluetooth device address @n - * The address is expressed as a @c 6 byte hexadecimal value delimited by colons. @n - * For example, "00:3D:47:EF:8A:03". + * The address is expressed as a @c 6 byte hexadecimal value delimited by colons. @n + * For example, "00:3D:47:EF:8A:03". */ Tizen::Base::String GetLocalDeviceAddress(void) const; @@ -261,7 +261,7 @@ public: * @since 2.0 * * @return The remaining time, in seconds, until the local device to be not discoverable. @n - * @c 0 will be returned if the current discoverable mode is not @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. + * @c 0 will be returned if the current discoverable mode is not @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. */ int GetRemainingTimeAsDiscoverable(void) const; @@ -277,20 +277,22 @@ public: /** * Sets the name of the local device. @n - * The searching device detects the local devices in close proximity based on the specified device name, and - * the name is only valid while an application is active. + * The searching device detects the local devices in close proximity based on the specified device name, and the + * name is only valid while an application is active. + * * @since 2.0 * @privlevel public * @privilege http://tizen.org/privilege/bluetooth.admin * * @return An error code * @param[in] deviceName The new device name. @n - * The specified device name is automatically truncated if its size is greater than @c 64 bytes. + * The specified device name is automatically truncated if its size is + * greater than @c 64 bytes. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified device name is an empty string. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks This method does not affect the system settings. + * @remarks This method does not affect the system settings. */ result SetLocalDeviceName(const Tizen::Base::String& deviceName); @@ -304,10 +306,11 @@ public: * @return An error code * @param[in] mode The new discoverable mode * @param[in] seconds The duration in seconds for which the local device is discoverable. @n - * The specified duration is adopted only if the specified @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. + * The specified duration is adopted only if the specified @c mode is + * @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c seconds should be greater than 0 if the specified - * @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. + * @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE. * @exception E_INVALID_OPERATION %Bluetooth is not activated. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. @@ -437,13 +440,14 @@ public: Tizen::Base::Collection::IList* GetPairedDeviceListN(void) const; /** - * Sets a remote device event listener for searching devices and services. @n + * Sets a remote device event listener for searching devices and services. * * @since 2.0 * * @return An error code * @param[in] pListener The device event listener to set @n - * If the specified listener is @c null, the listener currently set is unregistered. + * If the specified listener is @c null, the listener currently set is + * unregistered. * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @remarks Only one event listener can be set. @@ -554,10 +558,9 @@ public: /** * Unpairs with the paired device. @n - * The process of unpairing is to remove the specified device from the paired device list. No - * notification is transmitted to the remote device. @n - * This method is synchronous. - * Only when the result of this method is @c E_SUCCESS, the unpaired event is fired. + * The process of unpairing is to remove the specified device from the paired device list. No notification is + * transmitted to the remote device. @n + * This method is synchronous. Only when the result of this method is @c E_SUCCESS, the unpaired event is fired. * * @since 2.0 * @privlevel public diff --git a/inc/FNetBtBluetoothOppClient.h b/inc/FNetBtBluetoothOppClient.h index db077f7..52091e0 100755 --- a/inc/FNetBtBluetoothOppClient.h +++ b/inc/FNetBtBluetoothOppClient.h @@ -81,7 +81,7 @@ public: * @param[in] listener The event listener for the OPP client * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. */ result Construct(IBluetoothOppClientEventListener& listener); @@ -95,8 +95,8 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues@n - * For more information, see @ref CompIoPathPage "here". + * @compatibility This method has compatibility issues@n + * For more information, see @ref CompIoPathPage "here". * @endif * @privlevel public * @privilege http://tizen.org/privilege/bluetooth.opp diff --git a/inc/FNetBtBluetoothOppServer.h b/inc/FNetBtBluetoothOppServer.h index 5f6e36f..c3ff2d0 100755 --- a/inc/FNetBtBluetoothOppServer.h +++ b/inc/FNetBtBluetoothOppServer.h @@ -80,7 +80,7 @@ public: * @param[in] listener The event listener for the OPP server * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. */ result Construct(IBluetoothOppServerEventListener& listener); @@ -138,8 +138,8 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues. @n - * For more information, see @ref CompIoPathPage "here". + * @compatibility This method has compatibility issues. @n + * For more information, see @ref CompIoPathPage "here". * * @endif * @return An error code @@ -161,8 +161,8 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues. @n - * For more information, see @ref CompIoPathPage "here". + * @compatibility This method has compatibility issues. @n + * For more information, see @ref CompIoPathPage "here". * @endif * @privlevel public * @privilege http://tizen.org/privilege/bluetooth.opp diff --git a/inc/FNetBtBluetoothSppAcceptor.h b/inc/FNetBtBluetoothSppAcceptor.h index d5fe2fd..82606d2 100755 --- a/inc/FNetBtBluetoothSppAcceptor.h +++ b/inc/FNetBtBluetoothSppAcceptor.h @@ -81,7 +81,7 @@ public: * @param[in] listener The event listener for SPP acceptor * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. */ result Construct(IBluetoothSppAcceptorEventListener& listener); @@ -225,8 +225,8 @@ public: * @privilege http://tizen.org/privilege/bluetooth.spp * * @return An error code - * @param[in] buffer The data to send. @n - * The size of the buffer should not exceed @c 1000 bytes. + * @param[in] buffer The data to send. @n + * The size of the buffer should not exceed @c 1000 bytes. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance is in an invalid state. @n * For example, this instance has not been constructed as yet or %Bluetooth is diff --git a/inc/FNetBtBluetoothSppInitiator.h b/inc/FNetBtBluetoothSppInitiator.h index 18a6ebc..8f59e75 100755 --- a/inc/FNetBtBluetoothSppInitiator.h +++ b/inc/FNetBtBluetoothSppInitiator.h @@ -82,7 +82,7 @@ public: * @param[in] listener The event listener for the SPP initiator * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. */ result Construct(IBluetoothSppInitiatorEventListener& listener); @@ -178,7 +178,7 @@ public: * * @return An error code * @param[in] buffer The data to send. @n - * The size of the buffer should not exceed @c 1000 bytes. + * The size of the buffer should not exceed @c 1000 bytes. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance is in an invalid state. @n * For example, this instance has not been constructed as yet or %Bluetooth is diff --git a/inc/FNetBtBluetoothTypes.h b/inc/FNetBtBluetoothTypes.h index 01d2771..1e646e9 100755 --- a/inc/FNetBtBluetoothTypes.h +++ b/inc/FNetBtBluetoothTypes.h @@ -72,10 +72,10 @@ enum BluetoothDiscoverableMode enum BluetoothConnectionType { BT_CONNECTION_GENERIC, /**< The GENERIC CONNECTION - * @if OSPDEPREC - * @deprecated This enumeration field is deprecated. @n - * @endif - */ + * @if OSPDEPREC + * @deprecated This enumeration field is deprecated. @n + * @endif + */ BT_CONNECTION_SPP_ACCEPTOR, /**< The SPP ACCEPTOR CONNECTION */ BT_CONNECTION_SPP_INITIATOR, /**< The SPP INITIATOR CONNECTION */ BT_CONNECTION_OPP_SERVER, /**< The OPP SERVER CONNECTION */ @@ -217,9 +217,9 @@ enum BluetoothServiceType BT_SVC_HDP_SERVICE = 0x08000000, /**< The health device profile service type */ BT_SVC_MAP_SERVICE = 0x10000000, /**< The message access profile service type */ BT_SVC_ALL_SERVICE = 0x01FFFFFF, /**< The All-services-supported-by-BTA service type - * @if OSPDEPREC - * @deprecated This enumeration field is deprecated. - * @endif + * @if OSPDEPREC + * @deprecated This enumeration field is deprecated. + * @endif */ BT_SVC_NONE = 0 /**< The No service or unknown service type */ diff --git a/inc/FNetBtIBluetoothDeviceEventListener.h b/inc/FNetBtIBluetoothDeviceEventListener.h index 748e528..4590bf6 100755 --- a/inc/FNetBtIBluetoothDeviceEventListener.h +++ b/inc/FNetBtIBluetoothDeviceEventListener.h @@ -101,7 +101,8 @@ public: * * @param[in] targetDevice The remote device that sends its service list * @param[in] serviceList The service list that is received. @n - * The specified service list consists of Bluetooth::BluetoothServiceType values which are joined by OR operator. + * The specified service list consists of Bluetooth::BluetoothServiceType + * values which are joined by OR operator. * @param[in] r The result of receiving the service list * @exception E_SUCCESS The method is successful. * @exception E_REMOTE_SERVICE_NOT_FOUND The service list of the remote device is not found. @@ -111,17 +112,18 @@ public: /** * Called when a new remote device is paired with this local device. @n - * This method is able to be called even though the specified device already exists in the paired - * device list. Because the authorized key with the remote device is no more valid. @n + * This method is able to be called even though the specified device already exists in the paired device list. + * Because the authorized key with the remote device is no more valid. @n * If the pairing is explicitly requested by BluetoothManager::Pair() and the request fails, * OnBluetoothPairingFailed() is called instead of this method. * * @since 2.0 * * @param[in] pairedDevice The device to pair with the local device. @n - * The specified device may have no service list value and elements in the service UUID list because the - * retrieving the service list from the remote device fails.@n - * In that case, call BluetoothManager::RetrieveServiceList() to get the service list from the paired device. + * The specified device may have no service list value and elements in the service + * UUID list because the retrieving the service list from the remote device fails.@n + * In that case, call BluetoothManager::RetrieveServiceList() to get the service + * list from the paired device. */ virtual void OnBluetoothPaired(const BluetoothDevice& pairedDevice) = 0; diff --git a/inc/FNetBtIBluetoothOppClientEventListener.h b/inc/FNetBtIBluetoothOppClientEventListener.h index 0835e26..d2974ed 100755 --- a/inc/FNetBtIBluetoothOppClientEventListener.h +++ b/inc/FNetBtIBluetoothOppClientEventListener.h @@ -89,8 +89,8 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues. @n - * For more information, see @ref CompIoPathPage "here". + * @compatibility This method has compatibility issues. @n + * For more information, see @ref CompIoPathPage "here". * * @endif * @param[in] filePath The path of the file (including the file name) to transfer diff --git a/inc/FNetBtIBluetoothOppServerEventListener.h b/inc/FNetBtIBluetoothOppServerEventListener.h index 02e9e0c..7c1d6df 100755 --- a/inc/FNetBtIBluetoothOppServerEventListener.h +++ b/inc/FNetBtIBluetoothOppServerEventListener.h @@ -80,16 +80,17 @@ public: /** * Called when the file transfer has finished. * - * @since 2.0 + * @since 2.0 * - * @param[in] fileName The name of the file to transfer. @n - * If the name of the received file already exists in the destination path, the received file is renamed - * automatically and @c isCompleted is set to @c true. For renaming, the specified postfix is appended to - * the original file name. The postfix consists of an underscore and three digit sequence numbers starting - * from 001. For example, "MySong.mp3" may be changed to "MySong_001.mp3". - * @param[in] fileSize The size of the file to transfer - * @param[in] isCompleted Set to @c true if the transfer is successfully completed, @n - * else @c false + * @param[in] fileName The name of the file to transfer. @n + * If the name of the received file already exists in the destination path, the + * received file is renamed automatically and @c isCompleted is set to @c true. + * For renaming, the specified postfix is appended to the original file name. The + * postfix consists of an underscore and three digit sequence numbers starting from + * 001. For example, "MySong.mp3" may be changed to "MySong_001.mp3". + * @param[in] fileSize The size of the file to transfer + * @param[in] isCompleted Set to @c true if the transfer is successfully completed, @n + * else @c false */ virtual void OnOppTransferDone(const Tizen::Base::String& fileName, int fileSize, bool isCompleted) = 0;