//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
{
/**
* @class UuId
- * @brief This class is the base class of the wrapped UUID types and provides useful operators.
+ * @brief This class is the base class of the wrapped UUID types and provides methods for UUIDs.
*
* @since 2.0
*
- * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-').
+ * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal
+ * digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-').
*
* It also provides operators for assignment and equality, and methods for parsing, comparing, and generalization.
*
* @if OSPDEPREC
* Initializes an instance of %UuId with the value of the specified UUID.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as a UUID type is deprecated.
- * Instead of using this method, use the UuId(const byte uuid[16]) method.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as a UUID type is deprecated.
+ * Instead of using this method, use the UuId(const byte uuid[16]) method.
+ * @since 2.0
*
* @param[in] uuid An instance of UUID
* @endif
UuId(const UUID& uuid);
/**
- * Initializes an instance of %UuId with the uuid value.
+ * Initializes an instance of %UuId with the specified uuid value.
*
* @since 2.0
*
* @return @c true if the UUID and the %UuId instance are equal, @n
* else @c false
* @param[in] uuid1 An instance of UUID
- * @param[in] uuid2 An instance of %UuId
+ * @param[in] uuid2 An instance of %UuId
* @endif
*/
_OSP_EXPORT_ friend bool operator ==(const UUID& uuid1, const UuId& uuid2);
*
* @since 2.0
*
- * @return @c true if the two IDs are equal, @n
+ * @return @c true if the two instances are equal, @n
* else @c false
* @param[in] uuid An instance of %UuId
*/
*
* @return @c true if the specified instance of Object is equal to the current instance of %UuId, @n
* else @c false
- * @param[in] obj An instance of Object to compare
- * @remarks This method can be overridden to support value equality. Furthermore, the method must return the same result as the equality operator.
+ * @param[in] obj An instance of Object to compare
+ * @remarks This method can be overridden to support value equality. @n
+ * Furthermore, the method must return the same result
+ * as the equality operator.
* @see Tizen::Base::Object::GetHashCode()
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The integer value equivalent of the hash value of the current instance of %UuId
- * @remarks Two equal instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs. @n
- * The default implementation of this method returns the value of the current instance.
+ * @remarks
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must
+ * generate a random distribution for all inputs.
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the string representing the value of the current instance when implemented by a class.
+ * Gets the string representing the value of the current instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An instance of the String class with the unicode representation of the value of the current instance @n
- * If an error such as E_OUT_OF_MEMORY occurs, an empty string is returned.
+ * @return An instance of the String class with the unicode representation of the value of the current instance, @n
+ * else an empty string if an error such as @c E_OUT_OF_MEMORY occurs
*/
String ToString(void) const;
* @exception E_INVALID_ARG The string does not contain an %UuId that can be parsed.
* @remarks
* - The format of a string representing a %UuId value is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (For example, 130DF2EC-8233-4975-B03D-F0AD99E3449D).
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method guarantees that the original value of out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& str, UuId& uuid);
/**
* Generates a new %UuId instance with a random value.
*
- * @since 2.0
+ * @since 2.0
*
* @return A new %UuId instance
*/
static UuId* GenerateN(void);
/**
- * Get a new invalid %UuId instance.
+ * Gets a new invalid %UuId instance.
*
- * @since 2.0
+ * @since 2.0
*
* @return A new invalid %UuId instance
*/
static const UuId INVALID_UUID;
/**
- * A byte array of uuid value.
+ * A byte array of the uuid value.
*
* @since 2.0
*/
projects / platform / framework / native / appfw.git / blobdiff