From d986591b2974d3a3f5aabeb4cfa2f2670b95cc2b Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Mon, 1 Apr 2013 09:24:17 +0900 Subject: [PATCH] merge the reviewed files Change-Id: Id92cd222f3d4c54295c7072ae1a57be17c9fe54f --- inc/FNetNfcINdefPushManagerListener.h | 2 +- inc/FNetNfcINdefTagConnectionListener.h | 4 ++-- inc/FNetNfcITagConnectionListener.h | 2 +- inc/FNetNfcNdefMessage.h | 4 ++-- inc/FNetNfcNdefPushManager.h | 24 ++++++++++++------------ inc/FNetNfcNdefRecord.h | 10 +++++----- inc/FNetNfcNdefRecordType.h | 12 ++++++------ inc/FNetNfcNfcManager.h | 2 +- inc/FNetNfcTagConnection.h | 2 +- 9 files changed, 31 insertions(+), 31 deletions(-) diff --git a/inc/FNetNfcINdefPushManagerListener.h b/inc/FNetNfcINdefPushManagerListener.h index 65eac93..91b3129 100644 --- a/inc/FNetNfcINdefPushManagerListener.h +++ b/inc/FNetNfcINdefPushManagerListener.h @@ -58,7 +58,7 @@ public: * @since 2.0 * * @param[in] r The result of pushed NDEF message @n - * Following exceptions may be given through this parameter. + * The following exceptions may be given through this parameter. * @exception E_SUCCESS The method is successful. * @exception E_NOT_RESPONDING The device is not responding. * @exception E_OPERATION_FAILED The operation has failed. diff --git a/inc/FNetNfcINdefTagConnectionListener.h b/inc/FNetNfcINdefTagConnectionListener.h index 54eef12..1944dc3 100644 --- a/inc/FNetNfcINdefTagConnectionListener.h +++ b/inc/FNetNfcINdefTagConnectionListener.h @@ -61,7 +61,7 @@ public: * * @since 2.0 * - * @param[in] pMessage The read %NdefMessage object, @n + * @param[in] pMessage The read NdefMessage object, @n * else @c null if the method is not successful * @param[in] r An error code * @exception E_SUCCESS The method is successful. @@ -69,10 +69,10 @@ public: * @exception E_INVALID_FORMAT The read data cannot be formulated to the NDEF message. * @exception E_NOT_RESPONDING The target tag is not responding. * @exception E_SYSTEM A system error has occurred. - * @see NdefTagConnection::Read() * @remarks The input NdefMessage object must be deleted by the application after use, even outside this * method. The NdefMessage::RemoveAllRecords() method must be called with @c true as the input value * right before the %NdefMessage object is deleted. + * @see NdefTagConnection::Read() */ virtual void OnNdefReadCompletedN(NdefMessage* pMessage, result r) = 0; diff --git a/inc/FNetNfcITagConnectionListener.h b/inc/FNetNfcITagConnectionListener.h index ed7af5d..29935f0 100644 --- a/inc/FNetNfcITagConnectionListener.h +++ b/inc/FNetNfcITagConnectionListener.h @@ -64,7 +64,7 @@ public: * * @since 2.0 * - * @param[in] pResponse The response of the command as the ByteBuffer object, @n + * @param[in] pResponse The response of the command as the Tizen::Base::ByteBuffer object, @n * else @c null if the method is not successful * @param[in] r An error code * @exception E_SUCCESS The method is successful. diff --git a/inc/FNetNfcNdefMessage.h b/inc/FNetNfcNdefMessage.h index 35f2511..953c46e 100644 --- a/inc/FNetNfcNdefMessage.h +++ b/inc/FNetNfcNdefMessage.h @@ -92,7 +92,7 @@ public: * instance, @n * else @c false * @param[in] obj The object to compare - * @remark Two NdefMessage instances are equal only if they contain the same %NdefRecord instances in the + * @remark Two %NdefMessage instances are equal only if they contain the same NdefRecord instances in the * same order. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -117,7 +117,7 @@ public: /** * Searches for an NdefRecord object in this class. @n - * Gets the index of the NdefRecord object if the record is present. + * Gets the index of the %NdefRecord object if the record is present. * * @since 2.0 * diff --git a/inc/FNetNfcNdefPushManager.h b/inc/FNetNfcNdefPushManager.h index 17fc026..8c52166 100755 --- a/inc/FNetNfcNdefPushManager.h +++ b/inc/FNetNfcNdefPushManager.h @@ -86,7 +86,7 @@ public: * @feature %http://tizen.org/feature/network.nfc * * @return An error code - * @param[in] pListener An instance of INdefPushManagerListener. @n + * @param[in] pListener An instance of %INdefPushManagerListener. @n * If it is null, it will reset the listener. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -131,7 +131,7 @@ public: result Push(const NdefMessage& message); /** - * Activates Reserved Push feature which sends the preselected NDEF message to the connected NFC peer device on + * Activates the Reserved Push feature that sends the preselected NDEF message to the connected NFC peer device on * behalf of the application. * * @since 2.1 @@ -159,7 +159,7 @@ public: result ActivateReservedPush(void); /** - * Deactivates Reserved Push feature which sends the preselected NDEF message to the connected NFC peer device on + * Deactivates the Reserved Push feature that sends the preselected NDEF message to the connected NFC peer device on * behalf of the application. * * @since 2.1 @@ -187,7 +187,7 @@ public: result DeactivateReservedPush(void); /** - * Checks whether Reserved Push feature is activated. + * Checks whether the Reserved Push feature is activated. * * @since 2.1 * @@ -197,20 +197,20 @@ public: bool IsReservedPushActivated(void) const; /** - * Gets information of all the Reserved Push candidates. Each element of the result IMap consists of the package ID - * of application which registered the NDEF message and the description about the registered NDEF message. + * Gets information of all the Reserved Push candidates. @n Each element of the result Tizen::Base::Collection::IMap consists of the package ID + * of the application that registered the NDEF message and the description about the registered NDEF message. * * @since 2.1 * * @return An IMapT containing the pairs of package ID and message description if successful, @n * else @c null - * @remarks The key of the returned IMap should be casted to Tizen::App::PackageId pointer and the value should + * @remarks The key of the returned Tizen::Base::Collection::IMap should be casted to Tizen::App::PackageId pointer and the value should * be casted to Tizen::Base::String pointer. */ Tizen::Base::Collection::IMap* GetReservedPushCandidatesN(void) const; /** - * Picks out an NDEF message among all Reserved Push candidates by application ID. The selected NDEF message is + * Picks out an NDEF message among all the Reserved Push candidates by the application ID. @n The selected NDEF message is * pushed when a peer device is detected. * * @since 2.1 @@ -220,7 +220,7 @@ public: * Both the features are required. * * @return An error code - * @param[in] packageId The package ID of the application which registered the NDEF message to push + * @param[in] packageId The package ID of the application that registered the NDEF message to push * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c packageId is not found in the Reserved Push candidate list. * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @@ -239,7 +239,7 @@ public: result PickReservedPushMessage(const Tizen::App::PackageId& packageId); /** - * Gets the owner application ID of the picked NDEF message among all Reserved Push candidates. + * Gets the owner application ID of the picked NDEF message among all the Reserved Push candidates. * * @since 2.1 * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n @@ -264,7 +264,7 @@ public: /** * Registers an NDEF message as a Reserved Push candidate. @n - * If the message is picked out among the candidates. it is pushed to the detected peer device when the home screen + * If the message is picked out among the candidates, it is pushed to the detected peer device when the home screen * or the main menu is on top of the screen in the local device. * * @since 2.0 @@ -276,7 +276,7 @@ public: * @return An error code * @param[in] message The NDEF message to register * @param[in] description The description for the NDEF message to register @n - * This description is used in Reserved Push UI, for example, UI for + * This description can be used in Reserved Push UI, for example, UI for * getting user consent to send the registered message. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input @c message is invalid. @n diff --git a/inc/FNetNfcNdefRecord.h b/inc/FNetNfcNdefRecord.h index 67933d2..4367e05 100644 --- a/inc/FNetNfcNdefRecord.h +++ b/inc/FNetNfcNdefRecord.h @@ -91,10 +91,10 @@ public: * * @since 2.0 * - * @return @c true if the specified instance of %Object is equal to the calling %NdefRecord instance, @n + * @return @c true if the specified instance of Tizen::Base::Object is equal to the calling %NdefRecord instance, @n * else @c false * @param[in] obj The object to compare - * @remark Two %NdefRecord instances are equal only if they contain the same %NdefRecordType instances, + * @remark Two %NdefRecord instances are equal only if they contain the same NdefRecordType instances, * payload ID, and payload. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -147,7 +147,7 @@ public: * @param[in] type The record type to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input argument is invalid. @n - * For example, NDEF_TNF_EMPTY is not allowed as the input value if the identifier + * For example, @c NDEF_TNF_EMPTY is not allowed as the input value if the identifier * is not an empty string or the payload is not @c null. */ result SetRecordType(NdefRecordType& type); @@ -161,7 +161,7 @@ public: * @param[in] id The identifier of the payload * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION This operation is not allowed if the type name format of this record is - * NDEF_TNF_EMPTY. + * @c NDEF_TNF_EMPTY. * @exception E_INVALID_ARG The specified identifier is not unique compared to the other records in * the same NDEF message. * @exception E_INVALID_ENCODING_RANGE The specified input string contains code points that are outside the @@ -181,7 +181,7 @@ public: * @param[in] payload The specified payload data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION This operation is not allowed if the type name format of this record is - * NDEF_TNF_EMPTY. + * @c NDEF_TNF_EMPTY. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The @c payload is invalid. @n * For example, @c payload is not constructed. diff --git a/inc/FNetNfcNdefRecordType.h b/inc/FNetNfcNdefRecordType.h index bbb93a6..d1855cb 100644 --- a/inc/FNetNfcNdefRecordType.h +++ b/inc/FNetNfcNdefRecordType.h @@ -44,7 +44,7 @@ class _NdefRecordTypeImpl; * * @brief [Deprecated] * @deprecated This object is provided only for backward compatibility and will be deleted in the near future. - * Use NFC_NDEF_RTD_SMART_POSTER instead of this object. + * Use @c NFC_NDEF_RTD_SMART_POSTER instead of this object. * @since 2.0 * @endif */ @@ -63,7 +63,7 @@ _OSP_EXPORT_ extern const wchar_t NFC_NDEF_RTD_SMART_POSTER[]; * * @brief [Deprecated] * @deprecated This object is provided only for backward compatibility and will be deleted in the near future. - * Use NFC_NDEF_RTD_TEXT instead of this object. + * Use @c NFC_NDEF_RTD_TEXT instead of this object. * @since 2.0 * @endif */ @@ -82,7 +82,7 @@ _OSP_EXPORT_ extern const wchar_t NFC_NDEF_RTD_TEXT[]; * * @brief [Deprecated] * @deprecated This object is provided only for backward compatibility and will be deleted in the near future. - * Use NFC_NDEF_RTD_URI instead of this object. + * Use @c NFC_NDEF_RTD_URI instead of this object. * @since 2.0 * @endif */ @@ -151,13 +151,13 @@ public: NdefRecordType& operator =(const NdefRecordType& rhs); /** - * Compares the specified instance of an Object with the calling instance of %NdefRecordType. + * Compares the specified instance of Tizen::Base::Object with the calling instance of %NdefRecordType. * * @since 2.0 * * @return @c true if the values match, @n * else @c false - * @param[in] obj The Object to compare + * @param[in] obj The Tizen::Base::Object to compare * @remarks The method returns @c false if the specified object is not an %NdefRecordType instance. @n * Additionally, the comparison rules for the record type name are different depending on the Type * Name Format (TNF) value, as follows: @n @@ -222,7 +222,7 @@ public: * @remarks * - The returned name does not have the prefix @c "urn:nfc:wkt:" and @c "urn:nfc:ext:" defined by the * NFC forum. - * - In case of NDEF_TNF_ABSOLUTE_URI name format, this method returns the name in the same format as + * - In case of @c NDEF_TNF_ABSOLUTE_URI name format, this method returns the name in the same format as * it is given in the constructor, that is, with or without percent encoding. The name consists of * the characters encoded using the US_ASCII character set. */ diff --git a/inc/FNetNfcNfcManager.h b/inc/FNetNfcNfcManager.h index b8098ff..2060d9a 100755 --- a/inc/FNetNfcNfcManager.h +++ b/inc/FNetNfcNfcManager.h @@ -179,7 +179,7 @@ public: virtual ~NfcManager(void); /** - * Initializes this instance of %NfcManager with the specified listener. + * Initializes this instance of %NfcManager with the specified @c listener. * * @since 2.0 * @feature %http://tizen.org/feature/network.nfc diff --git a/inc/FNetNfcTagConnection.h b/inc/FNetNfcTagConnection.h index eb74933..88e2f1f 100644 --- a/inc/FNetNfcTagConnection.h +++ b/inc/FNetNfcTagConnection.h @@ -183,7 +183,7 @@ public: result SetTagConnectionListener(ITagConnectionListener* pListener); /** - * Sends the specified command to the target tag. + * Sends the specified @c command to the target tag. * * @since 2.0 * -- 2.7.4