//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
#include <FBaseComparerT.h>
#include <FBaseFloat.h>
-
namespace Tizen { namespace Base { namespace Collection
{
* void
* MyClass::HashMapTSample(void)
* {
- * HashMapT<int, int> map;
+ * HashMapT< int, int > map;
*
* // Constructs a %HashMapT instance with default capacity, load factor, hash code provider, and comparer
* map.Construct();
* map.Remove(key);
*
* // Uses an enumerator to access elements in the map
- * IMapEnumeratorT<int, int>* pMapEnum = map.GetMapEnumeratorN();
+ * IMapEnumeratorT< int, int >* pMapEnum = map.GetMapEnumeratorN();
* while (pMapEnum->MoveNext() == E_SUCCESS)
* {
* pMapEnum->GetKey(key);
* @since 2.0
*
* @return An error code
- * @param[in] capacity The initial capacity
- * @param[in] loadFactor The maximum ratio of elements to buckets
+ * @param[in] capacity The initial capacity
+ * @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the @c capacity or the @c loadFactor is negative.
}
/**
- * Initializes this instance of %HashMapT by copying the elements of a specified map.
+ * Initializes this instance of %HashMapT by copying the elements of the specified @c map.
*
* @since 2.0
*
}
/**
- * Initializes this instance of %HashMapT by copying the elements of a specified map,
- * with a specified load factor, hash code provider, and comparer.
+ * Initializes this instance of %HashMapT by copying the elements of the specified @c map,
+ * with the specified load factor, hash code provider, and comparer.
*
* @since 2.0
*
* @return An error code
* @param[in] map The map to copy
* @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor (0.75) is used.
+ * If it is @c 0, the default load factor (0.75) is used.
* @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes
* for all keys in this map
* @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys
}
/**
- * Gets the value associated with a specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
* @return The value associated with the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
+ * @param[in] key The key to locate
* @param[out] value The value associated with the key
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
}
/**
- * Gets the value associated with a specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
* @return The value associated with the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
+ * @param[in] key The key to locate
* @param[out] value The value associated with the key
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
}
/**
- * Removes the value associated with a specified key.
+ * Removes the value associated with the specified @c key.
*
* @since 2.0
*
}
/**
- * Replaces the value associated with a specified key with a new value.
+ * Replaces the value associated with the specified @c key with the specified new @c value.
*
* @since 2.0
*
}
/**
- * Checks whether a map contains the specified key.
+ * Checks whether a map contains the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified key, @n
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified @c key, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
}
/**
- * Checks whether a map contains the specified value.
+ * Checks whether a map contains the specified @c value.
*
* @since 2.0
*
- * @return @c true if the map contains the specified value, @n
+ * @return @c true if the map contains the specified @c value, @n
* else @c false
* @param[in] value The value to locate
*
HashMapT< KeyType, ValueType >& operator =(const HashMapT< KeyType, ValueType >& map);
/**
- * Copies all the pairs from a specified map to this map.
+ * Copies all the pairs from a specified @c map to this map.
*
* @return An error code
- * @param[in] map The map to copy
+ * @param[in] map The map to copy
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.@n
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
* The @c map is modified during the operation of this method.
*/
result AddAll(const IMapT< KeyType, ValueType >& map)
}
/**
- * Gets the hash value for a specified object.
+ * Gets the hash value for the specified object.
*
* @return The hash value for the specified object
* @param[in] obj The object to get hash value
* @since 2.0
*
* @return An error code
- * @param[out] obj The current object
+ * @param[out] obj The current object
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
* This enumerator is currently positioned before the first element or
/**
* Moves this enumerator to the next elements of the map.
- * When this enumerator is first created, or when the Reset() method is called, or when the MoveNext() method is first called, the enumerator positions itself to the first element in the map.
+ * When this enumerator is first created, or when the Reset() method is called, or when the %MoveNext() method is first called, the enumerator positions itself to the first element in the map.
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[out] key The current key
+ * @param[out] key The current key
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
* This enumerator is currently positioned before the first element or
projects / platform / framework / native / appfw.git / blobdiff