//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* @file FBaseStringHashCodeProvider.h
* @brief This is the header file for the %StringHashCodeProvider class.
*
- * This file contains declarations of the %StringHashCodeProvider class.
+ * This header file contains the declarations of the %StringHashCodeProvider class.
*/
#ifndef _FBASE_STRING_HASH_CODE_PROVIDER_H_
#define _FBASE_STRING_HASH_CODE_PROVIDER_H_
{
/**
* @class StringHashCodeProvider
- * @brief This is the header file for the %StringHashCodeProvider class.
+ * @brief This class provides the hash code of an instance of type %String.
*
* @since 2.1
*
- * The %StringHashCodeProvider class provides the hash code of instance of the String type.
+ * The %StringHashCodeProvider class provides the hash code of an instance of type String.
*
* The following example demonstrates how to use the %StringHashCodeProvider class.
*
StringHashCodeProvider(void);
/**
- * This destructor overrides Tizen::Base::Object::~Object()
+ * This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.1
*/
virtual ~StringHashCodeProvider(void);
/**
- * Gets the hash code of instance of the String type.
+ * Gets the hash code of an instance of type String.
*
* @since 2.1
*
- * @return The hash code of instance of the String type
+ * @return The hash code of the instance of type String
* @param[in] str The String instance whose hash code is requested
- * @remarks The hash algorithm is usually specific to a type.
- * Two equal instances must return the same hash value.
- * For better performance, the used hash function must generate a random distribution for all inputs.
+ * @remarks
+ * - The hash algorithm is usually specific to a type.
+ * - Two equal instances must return the same hash value.@n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(const Tizen::Base::String& str) const;
*
* @return The hash code of the specified object
* @param[in] obj The Object whose hash code is requested
- * @remarks The hash algorithm is usually specific to a type.
- * Two equal instances must return the same hash value.
- * For better performance, the used hash function must generate a random distribution for all inputs.
+ * @remarks
+ * - The hash algorithm is usually specific to a type.
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(const Tizen::Base::Object& obj) const;