*
* This header file contains the declarations of the %Boolean class.
*/
-#ifndef _FBASE_BOOL_H_
-#define _FBASE_BOOL_H_
+#ifndef _FBASE_BOOLEAN_H_
+#define _FBASE_BOOLEAN_H_
#include <FBaseObject.h>
#include <FBaseString.h>
*
* @return @c true if the values of the objects are not equal, @n
* else @c false
- * @param[in] rhs A instance of %Boolean to compare with the current instance
+ * @param[in] rhs An instance of %Boolean to compare with the current instance
*/
bool operator !=(const Boolean& rhs) const;
bool ToBool(void) const;
/**
- * Parses the specified string and converts it to a bool value.
+ * Parses the specified string and converts it to a @c bool value.
*
* @since 2.0
*
static bool Parse(const String& s);
/**
- * Parses the specified string and converts it to a bool value. @n
+ * Parses the specified string and converts it to a @c bool value. @n
* Case sensitivity can be controlled.
*
* @since 2.0
static bool Parse(const String& s, bool caseSensitive);
/**
- * Converts the value of the calling instance from bool to String.
+ * Converts the value of the calling instance from @c bool to String.
*
* @since 2.0
*
String ToString(void) const;
/**
- * Converts bool parameter to a String
- * instance of the String class and returns the string representation of the
- * input bool value (@c true or @c false).
+ * Converts a @c bool parameter to a String
+ * instance of the %String class and returns the string representation of the
+ * input @c bool value (@c true or @c false).
*
* @since 2.0
*
}} // Tizen::Base
-#endif //_FBASE_BOOL_H_
+#endif //_FBASE_BOOLEAN_H_
/**
- * Initializes this instance of %Buffer which is a view of the specified buffer. @n
+ * Initializes this instance of %Buffer which is a view of the specified @c buffer. @n
* This is similar to a copy constructor.
*
* @since 2.0
}
/**
- * Initializes this instance of %Buffer with the specified capacity.
+ * Initializes this instance of %Buffer with the specified @c capacity.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the @c pBuffer is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the @c index is larger than the @c length.
*/
result Construct(const Type* pBuffer, int index, int length, int capacity)
}
/**
- * This subscript operator returns the reference to the element indicated by the given index.
+ * This subscript operator returns the reference to the element indicated by the given @c index.
*
* @since 2.0
*
* @since 2.0
*
* @return @c true if the buffers being compared are equal, @n
- else @c false
+ * else @c false
* @param[in] buffer The buffer to compare with the current instance of %Buffer
* @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n
* and the two sequences of remaining elements are equal (considered independently of their starting positions).
* @since 2.0
*
* @return @c true if the buffers are not equal, @n
- else @c false
+ * else @c false
* @param[in] buffer The buffer to compare with the current instance of %Buffer
* @remarks This method returns @c false only if the two buffers being compared have the same @n
* number of remaining elements and the two sequences of remaining elements are equal @n
}
/**
- * Reads the value at the given index. @n
+ * Reads the value at the given @c index. @n
* Provides a way for absolute indexing and reading.
*
* @since 2.0
/**
- * Copies the specified range of values from the calling buffer to the specified destination array as per the given index of the array.
+ * Copies the specified range of values from the calling buffer to the specified destination array as per the given @c index of the array.
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
+ * @param[in] buffer The source buffer from where the bytes are read @n
* It must not be this buffer.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* between the number of elements remaining in the calling buffer and the source buffer). @n
* If there are more elements remaining in the calling buffer than elements remaining in the input instance,
* this method is equivalent to CopyFrom() method. If there are less remaining elements in the
- * calling buffer, the CopyFrom() method returns E_OVERFLOW and does not transfer
+ * calling buffer, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer
* while this method copies the number of remaining elements of the current instance.
* @see CopyFrom()
*
/**
- * Writes the specified value into the current buffer instance at the current position,
+ * Writes the specified @c value into the current buffer instance at the current position,
* and then increments the position. @n
* Provides a way for relative indexing and writing.
*
}
/**
- * Writes the specified value into the current instance of buffer at the given index. @n
+ * Writes the specified @c value into the current instance of buffer at the given @c index. @n
* Provides a way for absolute indexing and writing.
*
* @since 2.0
* @since 2.0
*
* @return An error code
- * @param[in] pArray A pointer to the array from which values are read
+ * @param[in] pArray A pointer to the array from where the values are read
* @param[in] index The starting index of the array
* @param[in] length The number of values read from the given array
* @exception E_SUCCESS The method is successful.
* @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
* The remainder of this buffer is smaller than @c length.
* @remarks This method copies @c length number of values from the source array,
- * starting from the given index in the array, into the calling
+ * starting from the given @c index in the array, into the calling
* buffer, starting at the current position.
* After the copy operation, the position is incremented by @c length.
* @see GetArray()
*
* @return An error code
* @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 mark has not been set.
* @remarks Invoking this method neither changes nor discards the mark's value.
*/
BufferBase(void);
/**
- * Initializes this instance of %BufferBase with the specified capacity.
+ * Initializes this instance of %BufferBase with the specified @c capacity.
*
* @since 2.0
*
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use ToLowerCase() method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than English alphabets.
*
* @since 2.0
* @endif
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use ToUpperCase() method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets.
*
* @since 2.0
* @endif
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets.
*
* @since 2.0
* @return An lowercase equivalent of the input Unicode character
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets.
*
* @since 2.0
* @return An uppercase equivalent of the input Unicode character
*
* @section CompCharacterIsAlphaNumericPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
* @endif
*/
*
* @section CompCharacterIsLetterPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
* @endif
*/
/**
* @if OSPDEPREC
- * Checks whether the input character is an lowercase alphabet.
+ * Checks whether the input character is a lowercase alphabet.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use IsLowerCase(wchar_t ch) method that supports Unicode characters.
+ * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters.
* @since 2.0
*
- * @return @c true if the input character is an lowercase English alphabet, @n
+ * @return @c true if the input character is a lowercase English alphabet, @n
* else @c false
* @param[in] ch The Unicode character
* @endif
static bool IsLower(wchar_t ch);
/**
- * Checks whether the input character is an lowercase alphabet. @n
+ * Checks whether the input character is a lowercase alphabet. @n
* Unicode characters other than English alphabets are also supported.
*
* @since 2.0
*
- * @return @c true if the input character is an lowercase alphabet, @n
+ * @return @c true if the input character is a lowercase alphabet, @n
* else @c false
* @param[in] ch The Unicode character
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets.
* @since 2.0
*
* @return @c true if the input character is an uppercase alphabet, @n
*
* @since 2.0
*
- * @return A Unicode character of the input digit with specified radix; null character (U+0000) otherwise
+ * @return A Unicode character of the input digit with specified @c radix @n
+ * else @c null character (U+0000)
* @param[in] digit The digit to determine the value
* @param[in] radix The radix
*/
*
* @since 2.0
*
- * @return A title case character equivalent for the input character. The character itself is returned if none is defined
+ * @return A title case character equivalent for the input character @n The character itself is returned if none is defined.
* @param[in] ch A Unicode character
*/
static wchar_t ToTitleCase(wchar_t ch);
static const wchar_t VALUE_MIN = 0x0000;
/**
- * The minimum radix available for conversion to and from strings.@n
- * As value as RADIX_BINARY.
+ * The minimum radix available for conversion to and from strings. @n
+ * Same value as RADIX_BINARY.
*
* @since 2.0
*/
*
* For more information on the %Base::Collection namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_namespace.htm">Collection</a>.
*
- * The following diagram illustrates the relationships between the classes belonging to the %Collection namespace.
+ * The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace.
*
* @image html base_collection_namespace_obj_based_classdiagram.png
*
{
/**
* @struct AllElementsDeleter
- * @brief This function object provides a resource clean-up function for collection
+ * @brief This function object provides a resource clean-up function for collection.
*
* This can be used with unique_ptr as a custom deleter.
*
struct AllElementsDeleter
{
/**
- * Deletes every element of the collection and the collection itself
+ * Deletes every element of the collection and the collection itself.
*
* @since 2.0
*
- * @param[in] c The Collection to clean up
- * @remarks Collection should be destructible and support RemoveAll(bool) method.
- * IList, IMap and IMultiMap support this concept.
+ * @param[in] c The collection to clean up
+ * @remarks The collection should be destructible and support the RemoveAll(bool) method.
+ * IList, IMap, and IMultiMap support this concept.
*/
template< typename Collection >
void operator ()(Collection* c)
*
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
* list.RemoveAll();
* }
* @endcode
*
* @param[in] deleter The function pointer to type of the element deleter
* @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @remarks After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
/**
* Initializes this instance of %ArrayList by copying the elements of the specified
- * collection. @n
+ * @c collection. @n
* The capacity of the list is the same as the number of elements copied.
*
* @since 2.0
/**
- * Adds the elements of the specified collection to the end of this list.
+ * Adds the elements of the specified @c collection to the end of this list.
*
* @since 2.0
*
virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const;
/**
- * Gets the object at the specified index of this list.
+ * Gets the object at the specified @c index of this list.
*
* @since 2.0
*
- * @return The object at the specified index of this list, @n
+ * @return The object at the specified @c index of this list, @n
* else @c null if the index is not valid
* @param[in] index The index of the object in the calling list to read
* @exception E_SUCCESS The method is successful.
/**
- * Gets the object at the specified index of this list.
+ * Gets the object at the specified @c index of this list.
*
* @since 2.0
*
- * @return The object at the specified index of this list, @n
+ * @return The object at the specified @c index of this list, @n
* else @c null if the index is not valid
* @param[in] index The index of the object to read
* @exception E_SUCCESS The method is successful.
/**
* Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter.
- * This method can be called before the collection is deleted.
+ * The %RemoveAll() can be called before the collection is deleted.
*
* @since 2.0
*/
virtual void RemoveAll(void);
/**
- * Replaces the object at the specified index with the specified object.
+ * Replaces the object at the specified @c index with the specified object.
*
* @since 2.0
*
virtual bool Contains(const Object& obj) const;
/**
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @since 2.0
*
- * @return @c true if the list contains all the elements of the specified collection, @n
+ * @return @c true if the list contains all the elements of the specified @c collection, @n
* else @c false
* @param[in] collection The collection to check for in the list
* @exception E_SUCCESS The method is successful.
virtual int GetHashCode(void) const;
/**
- * Distinguish between %ArrayList and LinkedList.
+ * Distinguish between ArrayList and LinkedList.
*
* @since 2.0
- * @return @c true if it is an %ArrayList, @n
- * else @c false if it is a LinkedList.
+ * @return @c true if it is an ArrayList, @n
+ * else @c false if it is a LinkedList
*/
virtual bool IsRandomAccessible(void) const
{
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
*
* @since 2.0
*
- * @param[in] deleter An function pointer to the element deleter to set
+ * @param[in] deleter A function pointer to the element deleter to set
*/
virtual void SetDeleter(DeleterFunctionType deleter);
}
/**
- * Gets the object at the specified index of the list.
+ * Gets the object at the specified @c index of the list.
*
* @since 2.0
*
* @param[in] index The index of the object to read
* @param[out] obj An object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the specified @c index is either equal to or greater than the number of elements or less than @c 0.
* @see SetAt()
*/
}
/**
- * Gets the object at the specified index of the list.
+ * Gets the object at the specified @c index of the list.
*
* @since 2.0
*
* @param[in] index The index of the object to read
* @param[out] obj An object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the specified @c index is either equal to or greater than the number of elements or less than @c 0.
* @see SetAt()
*/
}
/**
- * Searches for an object starting from the specified index. @n
+ * Searches for an object starting from the specified @c index. @n
* Gets the index of the object if found.
*
* @since 2.0
* It must be less than the number of elements.
* @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0.
* @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
* @see LastIndexOf()
* @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
+ * - The specified @c index is outside the bounds of the data structure. @n
* - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
* - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
* @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
* @param[in] obj The object to insert
* @param[in] index The index at which the object must be inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the @c index is greater than the number of elements or less than @c 0.
* @remarks The elements that follow the insertion point move down to accommodate the new element.
* If the @c index equals the number of elements in the list, the new element
* @return An error code
* @param[in] index The index of the object that is to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the specified @c index is greater than or equal to the number of elements or less than @c 0.
* @remarks The elements that follow the deleted object move up the list to occupy the empty location.
* @see InsertAt()
}
/**
- * Sets the object at a specified index of the current instance of ByteBuffer with the specified object.
+ * Sets the object at a specified @c index of the current instance of ByteBuffer with the specified object.
*
* @since 2.0
*
* @param[in] obj The object to set
* @param[in] index The index at which the object must be set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
* the specified @c index is either equal to or greater than the number of elements or less than @c 0.
* @see GetAt()
*/
}
/**
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to check for in the list
- * @param[out] out @c true if the list contains all the elements of the specified collection, @n
+ * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* delete pMapEnum;
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
* map.RemoveAll();
*
* }
*
* @param[in] deleter The function pointer to type of the element deleter
* @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
result Construct(int capacity = 16, float loadFactor = 0.75);
/**
- * Initializes an instance of a %HashMap class by copying the elements of the specified map.
+ * Initializes an instance of a %HashMap class by copying the elements of the specified @c map.
*
* @since 2.0
*
result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
/**
- * Initializes an instance of a %HashMap class by copying the elements of a specified map with a specified load factor, hash code provider, and comparer.
+ * Initializes an instance of a %HashMap class by copying the elements of the specified map with the specified load factor, hash code provider, and comparer.
*
* @since 2.0
*
virtual IMapEnumerator* GetMapEnumeratorN(void) const;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
* else @c null if an exception occurs
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
virtual const Object* GetValue(const Object& key) const;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
virtual IList* GetValuesN(void) const;
/**
- * Removes the values associated with a specified key.
+ * Removes the values associated with the specified @c key.
*
* @since 2.0
*
* @return An error code
* @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
* @see Add()
/**
* Removes all the object pointers in the collection. @n
- * This method can be called before deleting a collection.
+ * The %RemoveAll() method can be called before deleting a collection.
*
* @since 2.0
*/
virtual void RemoveAll(void);
/**
- * Sets the value associated with a specified key by allocating it a new value.
+ * Sets the value associated with the specified @c key by allocating it a new value.
*
* @since 2.0
*
virtual int GetCount(void) const;
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
- * @return @c true if the map contains the specified key, @n
+ * @return @c true if the map contains the specified @c key, @n
* else @c false
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
virtual bool ContainsKey(const Object& key) const;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the 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
*
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
HashMap& operator =(const HashMap& map);
/**
- * Copies all the pairs from a specified map to this map
+ * Copies all the pairs from the specified @c map to this map
*
* @return An error code
* @param[in] map The map to copy
result AddAll(const IMap& 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
*
* @since 2.0
*
- * @param[in] deleter An function pointer to the element deleter to set
+ * @param[in] deleter A function pointer to the element deleter to set
*/
virtual void SetDeleter(DeleterFunctionType deleter);
}
/**
- * 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
*
}
/**
- * Gets the value associated with a specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
}
/**
- * Gets the value associated with a specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
}
/**
- * 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[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
* @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
/**
* 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
*
* deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION).
*
* The %IBidirectionalEnumeratorT interface supports a bidirectional iteration over a collection.
- * One can only access the elements in a collection through %IBidirectionalEnumeratorT. The elements cannot be modified through this interface.
+ * One can only access the elements in a collection through %IBidirectionalEnumeratorT. The elements cannot be modified through this interface.
*
*/
template< class Type >
/**
* Moves %IBidirectionalEnumeratorT to the previous element of the collection. @n
- * A call to the MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection.
+ * A call to the %MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection.
*
* @since 2.0
*
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks Remove(obj, @b true) internally works as the below code:
* @code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
* the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveAt(index, @b true) internally works as the below code:
* @code
* - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
* - The @c count is greater than the number of elements starting from @c startIndex
* or less than @c 0.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveItems(startIndex, count, @b true) internally works as the below code:
* @code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the specified @c collection is modified during the operation of this method.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveItems(collection, @b true) internally works as the below code:
* @code
* @return An error code
* @param[in] forceDeletion Set to @c true to deallocate all the objects, @n
* else @c false
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveAll(@b true) internally works as the below code:
* @code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
* the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
- * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method.@n
+ * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
* If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
* @remarks SetAt(obj, index, @b true) internally works as the below code:
* @code
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const = 0;
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks Remove(key, @b true) internally works as the below code:
* @code
*
* @param[in] forceDeletion Set to @c true to deallocate all the objects, @n
* else @c false
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveAll(@b true) internally works as the below code:
* @code
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
* @remarks Use the Add() method to add a new key-value pair.
- * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method.@n
+ * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
* If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
* @remarks SetValue(key, value, @b true) internally works as the below code:
* @code
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const = 0;
* @remarks
* An enumerator remains valid as long as the map remains unchanged.
* If changes are made to the map, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an E_INVALID_OPERATION message.
+ * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message.
*
* The %IMapEnumeratorT interface supports simple iteration over a template-based map.
* Using this method, you can only access the elements in the map. You cannot modify the elements.
virtual result Add(const KeyType& key, const ValueType& value) = 0;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the specified key, @n
+ * @return The value associated with the specified @c key, @n
* else @c null if an exception occurs
* @param[in] key The key to find the associated value
* @param[out] value The value associated with the key
virtual result GetValue(const KeyType& key, ValueType& value) const = 0;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
virtual IListT< ValueType >* GetValuesN(void) const = 0;
/**
- * Removes the value associated with the specified key.
+ * Removes the value associated with the specified @c key.
*
* @since 2.0
*
virtual void RemoveAll(void) = 0;
/**
- * Replaces the value associated with the specified key with the specified value.
+ * Replaces the value associated with the specified @c key with the specified @c value.
*
* @since 2.0
*
virtual result SetValue(const KeyType& key, const ValueType& value) = 0;
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the 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[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. @n
- * The map contains the specified key.
+ * @exception E_SUCCESS The method is successful, or
+ * the map contains the specified @c key.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @see ContainsValue()
virtual result ContainsKey(const KeyType& key, bool& out) const = 0;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the 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
*
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks Remove(key, @b true) internally works as the below code:
* @code
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map.
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks Remove(key, value, @b true) internally works as the below code:
* @code
*
* @param[in] forceDeletion Set to @c true to deallocate all objects, @n
* else @c false
- * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method.@n
+ * @remarks Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
* If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
* @remarks RemoveAll(@b true) internally works as the below code:
* @code
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map.
* @remarks Use the Add() method to add a new key-value pair.
- * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance.@n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method.@n
+ * @remarks Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
* If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
* @remarks SetValue(key, value, newValue, @b true) internally works as the below code:
* @code
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const = 0;
*
* @since 2.1
*
- * @remarks This class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
+ * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
* So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
*/
{
public:
/**
- * Initializes this instance of %IteratorT class.
+ * Initializes an instance of %IteratorT class.
*
* @since 2.1
*
* @param[in] list A reference to the IList instance to convert
- * @param[in] isPostEnd A boolean value to check the end
+ * @param[in] isPostEnd A boolean value to check the end of a list
*/
explicit IteratorT(const IList& list, bool isPostEnd = false)
: __pList(&list)
}
/**
- * This is copy constructor of %IteratorT class.
+ * This is the copy constructor of the %IteratorT class.
*
* @since 2.1
*
}
/**
- * This is assignment operator of %IteratorT class.
+ * This is an assignment operator of the %IteratorT class.
*
* @since 2.1
*
}
/**
- * This is the indirection operator for %IteratorT class.
+ * This is the indirection operator for the %IteratorT class.
*
* @since 2.1
*
}
/**
- * This is the structure dereference operator for %IteratorT class.
+ * This is a structure dereference operator for the %IteratorT class.
*
* @since 2.1
*
- * @return A T type pointer equivalent to the pointer address
+ * @return A T type pointer that is equivalent to the pointer address
*/
T* operator->(void) const
{
}
/**
- * Moves to the next element of the collection.
+ * Moves to the next element in the collection.
*
* @since 2.1
*
* @return A reference to the %IteratorT type instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
*
* @since 2.1
*
- * @return An IteratorT instance
+ * @return An %IteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
- * @remarks It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T > operator++(int)
* @return A reference to the %IteratorT type instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
*
* @since 2.1
*
- * @return An IteratorT instance
+ * @return An %IteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
- * @remarks It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T > operator--(int)
}
/**
- * Checks the two %IteratorT instances for equality
+ * Checks the two %IteratorT instances for equality.
*
* @since 2.1
*
*
* @since 2.1
*
- * @return @c true if every member of the specified %IteratorT instance is not equal to the calling instance's members, @n
+ * @return @c true if any member of the specified %IteratorT instance is not equal to the calling instance's members, @n
* else @c false
* @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator
*/
}
/**
- * Exchanges values of the two %IteratorT instances
+ * Swaps values of two %IteratorT instances.
*
* @since 2.1
*
- * @param[in] rhs A reference to the %IteratorT instance to swap
+ * @param[in] rhs A reference to a %IteratorT instance to swap
*/
void swap(IteratorT< T >& rhs)
{
* delete pEnum;
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
* list.RemoveAll();
* }
* @endcode
*
* @param[in] deleter The function pointer to type of the element deleter
* @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
* delete pMapEnum;
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
* map.RemoveAll();
* }
* @endcode
*
* @param[in] deleter The function pointer to type of the element deleter
* @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
/**
* Rehashes the contents of this map into a new array with a
- * larger capacity.@n
+ * larger capacity. @n
* This method is called automatically when the number of keys in this map reaches its threshold.
*
* @return An error code
*
* @since 2.0
*
- * @param[in] deleter An function pointer to the element deleter to set
+ * @param[in] deleter A function pointer to the element deleter to set
*/
virtual void SetDeleter(DeleterFunctionType deleter);
*
* @since 2.1
*
- * @remarks This class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
+ * @remarks The %PairIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
* So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
*/
}
/**
- * This is copy constructor of %PairIteratorT class.
+ * This is the copy constructor of the %PairIteratorT class.
*
* @since 2.1
*
* @param[in] rhs A reference to the %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are null.
+ * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
}
/**
- * This is assignment operator of %PairIteratorT class.
+ * This is assignment operator of the %PairIteratorT class.
*
* @since 2.1
*
* @return A reference to the %PairIteratorT instance
* @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are null.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
}
/**
- * This is the indirection operator for %PairIteratorT class.
+ * This is the indirection operator for the %PairIteratorT class.
*
* @since 2.1
*
}
/**
- * This is the const version structure dereference operator for %PairIteratorT class.
+ * This is the const version structure dereference operator for the %PairIteratorT class.
*
* @since 2.1
*
* @return A reference to the %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
* @return A %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
}
/**
- * Checks the two %PairIteratorT instances for equality
+ * Checks the two %PairIteratorT instances for equality.
*
* @since 2.1
*
*
* @since 2.1
*
- * @return @c true if every member of the specified %PairIteratorT instance is not equal to the calling instance's members, @n
+ * @return @c true if any member of the specified %PairIteratorT instance is not equal to the calling instance's members, @n
* else @c false
* @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator
*/
}
/**
- * Exchanges values of the two %PairIteratorT instances
+ * Swaps values of the two %PairIteratorT instances.
*
* @since 2.1
*
*
* @since 2.1
*
- * @remarks This class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
+ * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
* So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
*/
*
* @param[in] list A reference to the IList instance to convert
* @param[in] position A start position
- * @remarks RandomIteratorT only supports random accessible collection for performance.
+ * @remarks %RandomIteratorT only supports random accessible collection for performance.
* @see Tizen::Base::Collection::IList::IsRandomAccessible()
*/
explicit RandomIteratorT(const IList& list, int index = 0)
}
/**
- * This is copy constructor of %RandomIteratorT class.
+ * This is the copy constructor of the %RandomIteratorT class.
*
* @since 2.1
*
}
/**
- * This is the assignment operator of %RandomIteratorT class.
+ * This is the assignment operator of the %RandomIteratorT class.
*
* @since 2.1
*
}
/**
- * This is the indirection operator for %RandomIteratorT class.
+ * This is the indirection operator for the %RandomIteratorT class.
*
* @since 2.1
*
}
/**
- * This is the structure dereference operator for %RandomIteratorT class.
+ * This is the structure dereference operator for the %RandomIteratorT class.
*
* @since 2.1
*
}
/**
- * Checks two %RandomIteratorT instances for equality
+ * Checks two %RandomIteratorT instances for equality.
*
* @since 2.1
*
*
* @since 2.1
*
- * @return @c true if every member of the specified %RandomIteratorT instance is not equal to the calling instance's members, @n
+ * @return @c true if any member of the specified %RandomIteratorT instance is not equal to the calling instance's members, @n
* else @c false
* @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator
*/
}
/**
- * Checks l-value is less than r-value
+ * Checks l-value is less than r-value.
*
* @since 2.1
*
}
/**
- * Checks whether l-value is greater than r-value
+ * Checks whether l-value is greater than r-value.
*
* @since 2.1
*
}
/**
- * Increases __index as many as diff
+ * Increases __index as specified by the diff parameter.
*
* @since 2.1
*
}
/**
- * Decrease __index as many as diff
+ * Decrease __index as specified by the diff parameter.
*
* @since 2.1
*
}
/**
- * This is the index operator for %RandomIteratorT class.
+ * This is the index operator for the %RandomIteratorT class.
*
* @since 2.1
*
}
/**
- * Exchanges values of the two %RandomIteratorT instances
+ * Swaps values of the two %RandomIteratorT instances.
*
* @since 2.1
*
}
/**
- * Initializes this instance of %StackT with the specified capacity.
+ * Initializes this instance of %StackT with the specified @c capacity.
*
* @since 2.0
*
* @param[in] capacity The number of elements @n
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the specified @c capacity is negative.
*/
result Construct(int capacity = DEFAULT_CAPACITY)
}
/**
- * Initializes this instance of %StackT that contains the elements of the specified collection. @n
+ * Initializes this instance of %StackT that contains the elements of the specified @c collection. @n
* The capacity of the stack is the same as the number of elements copied.
*
* @since 2.0
}
/**
- * Checks whether this stack contains all of the elements in the specified collection.
+ * Checks whether this stack contains all of the elements in the specified @c collection.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to locate
- * @param[out] out Set to @c true if this stack contains all of the elements in the specified collection, @n
+ * @param[out] out Set to @c true if this stack contains all of the elements in the specified @c collection, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
/**
* Moves this enumerator to the next element of the stack. @n
* When this enumerator is first created or after a call to Reset(),
- * the first call to MoveNext() positions this enumerator to the first element in the stack.
+ * the first call to %MoveNext() positions this enumerator to the first element in the stack.
*
* @since 2.0
*
*
* @since 2.1
*
- * This %StlConverter class provides static methods to convert Tizen Collection to STL Container and vice versa.
+ * The %StlConverter class provides static methods to convert Tizen Collection to STL Container and vice versa.
* The following example demonstrates how to use the %StlConverter class.
*
* @code
* // The case of Collection to STL Container
* IList* pList1 = someNativeObject.GetSomeIntegerListN();
*
- * // vector may be created through IteratorT
+ * // vector can be created through IteratorT
* vector< Integer* > vec1(
* StlConverter::GetBeginIterator< Integer* >(pList1),
* StlConverter::GetEndIterator< Integer* >(pList1));
}
/**
- * Gets the STL compatible iterator referring to the first element in the IMap instance.
- * This iterator can be used in algorithms which requires paired iterator.
+ * Gets the STL compatible iterator referring to the first element in the IMap instance. @n
+ * This iterator can be used in algorithms that require paired iterators.
*
* @since 2.1
*
}
/**
- * Gets the STL compatible iterator referring to the post-end element in the IMap instance.
- * This iterator can be used in algorithms which requires paired iterator.
+ * Gets the STL compatible iterator referring to the post-end element in the IMap instance. @n
+ * This iterator can be used in algorithms that require paired iterators.
*
* @since 2.1
*
}
/**
- * Gets the STL compatible iterator referring to the first element in the IMultiMap instance.
- * This iterator can be used in algorithms which requires paired iterator.
+ * Gets the STL compatible iterator referring to the first element in the IMultiMap instance. @n
+ * This iterator can be used in algorithms that require paired iterators.
*
* @since 2.1
*
}
/**
- * Gets the STL compatible iterator referring to the post-end element in the IMultiMap instance.
- * This iterator can be used in algorithms which requires paired iterator.
+ * Gets the STL compatible iterator referring to the post-end element in the IMultiMap instance. @n
+ * This iterator can be used in algorithms that require paired iterators.
*
* @since 2.1
*
* @param[in] deleter The function pointer to type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter.
- * This gives the collection the ownership of elements and the collection will destroy elements. @n
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
+ * This gives the collection the ownership of elements and the collection can destroy elements. @n
* On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
* as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * That implies transfer of the ownership of elements to the collection is not required.
* @remarks The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @param[in] deleter The function pointer to type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter.
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
* This gives the collection the ownership of elements and the collection will destroy elements. @n
* On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
* as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * That implies transfer of the ownership of elements to the collection is not required.
* @remarks The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @param[in] deleter The function pointer to type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter.
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
* This gives the collection the ownership of elements and the collection will destroy elements. @n
* On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
* as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * That implies transfer of the ownership of elements to the collection is not required.
* @remarks The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @param[in] deleter The function pointer to type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter.
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
* This gives the collection the ownership of elements and the collection will destroy elements. @n
* On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
* as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * That implies transfer of the ownership of elements to the collection is not required.
* @remarks The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @brief This is the header file for the element deleter.
*
* This header file contains the declarations of the element deleter.
- * Depending on the element deleter, collection decides whether removing the object or not.
+ * Depending on the element deleter, collection decides whether to remove the object or not.
*/
#ifndef _FBASE_COL_TYPES_H_
#define _FBASE_COL_TYPES_H_
typedef void (*DeleterFunctionType)(Object* pObj);
/**
- * This function doesn't remove the object.
+ * This function does not remove the object.
*
* @since 2.0
*
- * @param[in] pObj The pointer to object to remove
+ * @param[in] pObj The pointer to the object to remove
*/
_OSP_EXPORT_ void NoOpDeleter(Object* pObj);
*
* @since 2.0
*
- * @param[in] pObj The pointer to object to remove
+ * @param[in] pObj The pointer to the object to remove
*/
_OSP_EXPORT_ void SingleObjectDeleter(Object* pObj);
*
* @since 2.0
*
- * @param[in] pObj The pointer to object to remove
+ * @param[in] pObj The pointer to the object to remove
*/
_OSP_EXPORT_ void ArrayDeleter(Object* pObj);
virtual ~ComparerT(void) { }
/**
- * Compare two String instance
+ * Compare two String instances.
*
* @since 2.1
*
* @return Always returns E_SUCCESS
- * @param[in] str1 String instance to compare
- * @param[in] str2 String instance to compare
- * @param[in] cmp Integer value for result
+ * @param[in] str1 The String instance to compare
+ * @param[in] str2 The String instance to compare
+ * @param[in] cmp An integer value for result
*/
virtual result Compare(const Tizen::Base::String& str1, const Tizen::Base::String& str2, int& cmp) const
{
typedef unsigned char byte;
/**
- * @c result is a @c unsigned @c long type and indicates the result of the method execution.
+ * @c result is an @c unsigned @c long type and indicates the result of the method execution.
* @since 2.0
*/
typedef unsigned long result;
*
* @since 2.0
*
- * @param[in] value The instance of TimeSpan
+ * @param[in] value An instance of TimeSpan
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
* The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
void SetValue(const DateTime& value);
/**
- * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, and second.
+ * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, and @c second.
*
* @since 2.0
*
result SetValue(int year, int month, int day, int hour = 0, int minute = 0, int second = 0);
/**
- * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, second and millisecond.
+ * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, @c second, and @c millisecond.
*
* @since 2.1
*
* @param[in] millisecond The millisecond to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * Either the arguments are greater than the value returned by GetMaxValue() or
+ * Either the arguments are greater than the value returned by GetMaxValue() or
* are less than the value returned by GetMinValue(), or
- * the arguments contain invalid values.
+ * the arguments contain invalid values.
* For example, day is 31 when month is 2.
*/
result SetValue(int year, int month, int day, int hour, int minute, int second, int millisecond);
/**
- * Sets the current instance of %DateTime with the specified number of ticks.
- * The tick value represents dates and times with long long type ranging from January 1, 1 A.D. 00:00:00.000 am.
+ * Sets the current instance of %DateTime with the specified number of %ticks.
+ * The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am.
*
* @since 2.1
*
* @return An error code
- * @param[in] ticks The number of ticks (in milliseconds)
+ * @param[in] ticks The number of ticks
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
- * Either the arguments are greater than the value returned by GetMaxValue() or
+ * Either the arguments are greater than the value returned by GetMaxValue() or
* are less than the value returned by GetMinValue(), or
- * the arguments contain invalid values.
+ * the arguments contain invalid values.
* For example, day is 31 when month is 2.
*/
result SetValue(long long ticks);
* @since 2.0
*
* @return @c true if the specified instance of Object is equivalent to the current instance of %DateTime, @n
- else @c false
+ * else @c false
* @param[in] obj The object to compare with the current instance of %DateTime
* @see Tizen::Base::Object::GetHashCode()
*/
TimeSpan GetTimeOfDay(void) const;
/**
- * Gets the number of days in the specified month of the specified year.
+ * Gets the number of @c days in the specified @c month of the specified @c year.
*
* @since 2.0
*
/**
* Gets the tick of the current instance of %DateTime.
- * The tick value represents dates and times with long long ranging from January 1, 1 A.D. 00:00:00.000 am.
+ * The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am.
*
* @since 2.1
*
- * @return A long long value indicating the tick of the current instance of %DateTime
+ * @return A @c long @c long value indicating the tick of the current instance of %DateTime
*/
long long GetTicks(void) const;
bool IsLeapYear(void) const;
/**
- * Checks whether the specified year is a leap year.
+ * Checks whether the specified @c year is a leap year.
*
* @since 2.0
*
result Add(const DoubleMatrix& matrix);
/**
- * Adds the value to each matrix members of current instance of %DoubleMatrix.
+ * Adds the value to each matrix members of the current instance of %DoubleMatrix.
*
* @since 2.0
*
result Multiply(const DoubleMatrix& matrix);
/**
- * Multiplies the value to each matrix members of current instance of %DoubleMatrix.
+ * Multiplies the value with each matrix members of the current instance of %DoubleMatrix.
*
* @since 2.0
*
void Multiply(double value);
/**
- * Negates the matrix members of current instance of %DoubleMatrix.
+ * Negates the matrix members of the current instance of %DoubleMatrix.
*
* @since 2.0
*/
result Subtract(const DoubleMatrix& matrix);
/**
- * Subtracts the value from each matrix members of current instance of %DoubleMatrix.
+ * Subtracts the value from each matrix members of the current instance of %DoubleMatrix.
*
* @since 2.0
*
* @return A 32-bit @c signed integer value
* @param[in] str0 The first %String instance to compare
* @param[in] str1 The second %String instance to compare
- * @remarks The method performs an ordinal comparison of each Unicode
+ * @remarks This method performs an ordinal comparison of each Unicode
* character contained in the two given %String instances.
* For instance, "U+xxx" is greater than "U+XXX", but smaller than "U+yyy".
*
* > 0 if the value of the current instance is greater than the value of the specified %String instance
*@endcode
* @param[in] str An instance of %String to compare
- * @remarks The method performs an ordinal comparison of each Unicode character. For instance,
+ * @remarks This method performs an ordinal comparison of each Unicode character. For instance,
* L"U+xxx" is greater than L"U+XXX", but smaller than L"U+yyy".
*/
int CompareTo(const String& str) const;
* @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %String, @n
* else @c false
* @param[in] obj An instance of Object to compare
- * @remarks The method returns @c false if the specified @c obj is not a string.
+ * @remarks This method returns @c false if the specified @c obj is not a string.
* @see Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
* @param[in] caseSensitive Set to @c true to perform a case sensitive ordinal comparison of the strings, @n
* else @c false
*
- * @remarks The method performs an ordinal comparison of each Unicode
+ * @remarks This method performs an ordinal comparison of each Unicode
* character contained in the two given %String instances.
*/
bool Equals(const String& str, bool caseSensitive) const;
* @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 an 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.
* @return @c true if the specified instance is equal to the current instance, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks The method returns @c true if all the attributes in the instance are the same.
+ * @remarks This method returns @c true if all the attributes in the instance are the same.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @since 2.1
*
* The %Scanner class breaks the input, which can be either a %String instance or strings from a file, into tokens using a delimiter.
- * The delimiter is set by whitespace as a default value. The resulting tokens are converted into values of different types according
+ * The delimiter is set to whitespace as a default value. The resulting tokens are converted into values of different types according
* to the methods in %Scanner.
*
* The following example demonstrates how to use the %Scanner class.
virtual ~Scanner(void);
/**
- * Initializes the current instance of %Scanner with the specified instance of string.
+ * Initializes the current instance of %Scanner with the specified instance of String.
*
* @since 2.1
* @return An error code
- * @param[in] inputStr The string to scan.
+ * @param[in] inputStr The string to scan
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0.
*/
result Construct(const String& inputStr);
/**
- * Initializes the current instance of %Scanner with a file which includes the strings being scanned.
+ * Initializes the current instance of %Scanner with a file that includes the strings that are being scanned.
*
* @since 2.1
* @return An error code
- * @param[in] inputFilePath The file to be read to construct input data
- * @param[in] encodingScheme The encoding type of the file.
+ * @param[in] inputFilePath The file to read to construct input data
+ * @param[in] encodingScheme The encoding type of the file
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The input file does not exist.
* @exception E_IO Invalid file operation
* @exception E_INVALID_ARG The specified encoding scheme does not exist.
- * @remarks The supported encoding schemes are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258,KSC5601, BIG5, GB2312, Shift_JIS and ISO-2022-jp.
+ * @remarks The supported encoding schemes are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, KSC5601, BIG5, GB2312, Shift_JIS, and ISO-2022-jp.
*/
result Construct(const String& inputFilePath, const String& encodingScheme);
/**
- * Gets the substring of the input data matching to the pattern constructed from the specified string.
+ * Gets the substring of the input data matching to the pattern constructed from the specified string. @n
* Delimiter will be ignored and the returned string does not include any line terminator.
- * If not found such pattern in the input data up to the next line terminator, return an empty string through the out parameter, matchedStr.
+ * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr.
*
* @since 2.1
* @return An error code
- * @param[in] patternStr The string to construct the pattern.
- * @param[out] matchedStr The matched string or empty string.
+ * @param[in] patternStr The string to construct the pattern
+ * @param[out] matchedStr The matched string or empty string
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0.
* @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance.
result FindInLine(const String& patternStr, String& matchedStr);
/**
- * Gets the substring matching the pattern from the input data.
+ * Gets the substring matching the pattern from the input data. @n
* Delimiter will be ignored and the returned string does not include any line terminator.
- * If not found such pattern in the input data up to the next line terminator, return an empty string through the out parameter, matchedStr.
+ * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr.
*
* @since 2.1
* @return An error code
- * @param[in] pattern The pattern to be compiled for finding substring from input data.
- * @param[out] matchedStr The matched string or empty string.
+ * @param[in] pattern The pattern to compile for finding substring from input data
+ * @param[out] matchedStr The matched string or empty string
* @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance.
*/
result FindInLine(const RegularExpression& pattern, String& matchedStr);
/**
- * Gets the next token as %signed char. Next token is converted to signed char using default radix.
- * The signed char can hold value from -128 to 127.
+ * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using default radix.
+ * The @c signed @c char can hold value from -128 to 127.
*
* @since 2.1
* @return An error code
- * @param[out] nextSignedChar The next token as a signed char.
+ * @param[out] nextSignedChar The next token as a @c signed @c char
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %signed char value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid signed @c char value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextSignedChar(signed char& nextSignedChar) const;
/**
- * Gets the next token as %signed char. Next token is converted to signed char using specified radix.
- * The signed char can hold value from -128 to 127.
+ * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using specified @c radix.
+ * The @c signed @c char can hold value from -128 to 127.
*
* @since 2.1
* @return An error code
- * @param[out] nextSignedChar The next token as a signed char.
- * @param[in] radix The radix to be used for conversion.
+ * @param[out] nextSignedChar The next token as a @c signed @c char
+ * @param[in] radix The radix to use for conversion
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %signed char value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c char value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextSignedChar(signed char& nextSignedChar, int radix) const;
/**
- * Gets the next token as %int. Next token is converted to signed integer using default radix.
+ * Gets the next token as @c int. @n Next token is converted to signed integer using default radix.
* The signed integer can hold value from -2^31 to 2^31-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextInt The next token as a signed integer.
+ * @param[out] nextInt The next token as a signed integer
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %integer value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextInt(int& nextInt) const;
/**
- * Gets the next token as %int. Next token is converted to signed integer using specified radix.
+ * Gets the next token as @c int. @n Next token is converted to signed integer using specified @c radix.
* The signed integer can hold value from -2^31 to 2^31-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextInt The next token as a signed integer.
- * @param[in] radix The radix to be used for conversion.
+ * @param[out] nextInt The next token as a signed integer
+ * @param[in] radix The radix to use for conversion
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %integer value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextInt(int& nextInt, int radix) const;
/**
- * Gets the next token as %short. Next token is converted to signed short using default radix.
- * The signed short can hold value from -2^15 to 2^15-1.
+ * Gets the next token as @c short. @n Next token is converted to signed @c short using default radix.
+ * The signed @c short can hold value from -2^15 to 2^15-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextShort The next token as a signed short.
+ * @param[out] nextShort The next token as a signed @c short
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %short value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextShort(short& nextShort) const;
/**
- * Gets the next token as %short. Next token is converted to signed short using specified radix.
- * The signed short can hold value from -2^15 to 2^15-1.
+ * Gets the next token as @c short. @n Next token is converted to signed @c short using specified @c radix.
+ * The signed @c short can hold value from -2^15 to 2^15-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextShort The next token as a signed short.
- * @param[in] radix The radix to be used for conversion.
+ * @param[out] nextShort The next token as a signed @c short
+ * @param[in] radix The radix to use for conversion
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %short value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextShort(short& nextShort, int radix) const;
/**
- * Gets the next token as %long long. Next token is converted to signed long long using default radix.
- * The signed long can hold value from -2^63 to 2^63-1.
+ * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using default radix.
+ * The signed @c long @c long can hold value from -2^63 to 2^63-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextLongLong The next token as a signed long long.
+ * @param[out] nextLongLong The next token as a signed @c long @c long
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %long long value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextLongLong(long long& nextLongLong) const;
/**
- * Gets the next token as %long long. Next token is converted to signed long long using specified radix.
- * The signed long can hold value from -2^63 to 2^63-1.
+ * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using specified @c radix.
+ * The signed @c long @c long can hold value from -2^63 to 2^63-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextLongLong The next token as a signed short.
- * @param[in] radix The radix to be used for conversion.
+ * @param[out] nextLongLong The next token as a signed @c long @c long
+ * @param[in] radix The radix to use for conversion
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %short value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextLongLong(long long& nextLongLong, int radix) const;
/**
- * Gets the next token as %float. Next token is converted to float.
- * The signed float can hold a single-precision 32-bit floating number.
+ * Gets the next token as @c float. @n Next token is converted to @c float.
+ * The signed @c float can hold a single-precision 32-bit floating number.
*
* @since 2.1
* @return An error code
- * @param[out] nextFloat The next token as a float.
+ * @param[out] nextFloat The next token as a @c float
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %float value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c float value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextFloat(float& nextFloat) const;
/**
- * Gets the next token as %double. Next token is converted to double.
- * The signed double can hold a double-precision 64-bit floating number.
+ * Gets the next token as @c double. @n Next token is converted to @c double.
+ * The signed @c double can hold a double-precision 64-bit floating number.
*
* @since 2.1
* @return An error code
- * @param[out] nextDouble The next token as a double.
+ * @param[out] nextDouble The next token as a @c double
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %double value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c double value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextDouble(double& nextDouble) const;
/**
- * Gets the next token as %bool. Next token is converted to boolean.
+ * Gets the next token as @c bool. @n Next token is converted to boolean.
* Nothing can be converted, except true/TRUE or false/FALSE.
*
* @since 2.1
* @return An error code
- * @param[out] nextBool The next token as bool.
+ * @param[out] nextBool The next token as @c bool
* @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid %bool value.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c bool value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextBool(bool& nextBool) const;
/**
- * Gets the input string up to next line delimiter and advances the %Scanner to the beginning of the next line.
+ * Gets the input string up to next line delimiter and advances the %Scanner to the beginning of the next line. @n
* The returned string does not include any line terminator.
*
* @since 2.1
* @return An error code
- * @param[out] nextLine The next line as an instance of string.
+ * @param[out] nextLine The next line as an instance of String
* @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining line.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining lines for the current instance of %Scanner.
*
- * The following example demonstrates how to use this method.
+ * The following example demonstrates how to use the %GetNextLine() method.
*
* @code
*
result GetNextLine(String& nextLine) const;
/**
- * Gets the next token as %String.
+ * Gets the next token as String.
*
* @since 2.1
* @return An error code
- * @param[out] nextTok The next token as an instance of string.
+ * @param[out] nextTok The next token as an instance of String
* @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*
- * The following example demonstrates how to use this method.
+ * The following example demonstrates how to use the %GetNextToken() method.
* @code
*
* String str = "1 hundred bricks 2 bricks 3 hundred bricks 4 bricks";
result GetNextToken(String& nextTok) const;
/**
- * Gets the next token as %String if it matches to the pattern constructed from the specified string.
+ * Gets the next token as String if it matches to the pattern constructed from the specified string.
*
* @since 2.1
* @return An error code
- * @param[in] pattern The string to construct the pattern.
- * @param[out] nextTok The next token as an instance of string, or empty string if not matched.
+ * @param[in] pattern The string to construct the pattern
+ * @param[out] nextTok The next token as an instance of String, or empty string if not matched
* @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The next token does not match to the pattern.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextToken(const String& pattern, String& nextTok) const;
/**
- * Gets the next token as %String if it matches to the pattern.
+ * Gets the next token as String if it matches to the pattern.
*
* @since 2.1
* @return An error code
* @param[in] pattern The pattern to find.
- * @param[out] nextTok The next token as an instance of string, or empty string if not matched.
+ * @param[out] nextTok The next token as an instance of String, or empty string if not matched.
* @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The next token does not match to the pattern.
- * @exception E_DATA_NOT_ENOUGH The current instance of %Scanner has no remaining token.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextToken(const RegularExpression& pattern, String& nextTok) const;
* @since 2.1
* @return @c true if the next token matches to the pattern constructed from the specified string, @n
* else @c false
- * @param[in] pattern The string to construct the pattern.
+ * @param[in] pattern The string to construct the pattern
*/
bool HasNextToken(const String& pattern) const;
* @since 2.1
* @return @c true if the next token matches to the pattern, @n
* else @c false
- * @param[in] pattern The pattern to find.
+ * @param[in] pattern The pattern to find
*/
bool HasNextToken(const RegularExpression& pattern) const;
/**
- * Checks whether the next token can be translated into a valid %signed char value in the default radix.
- * The signed char can hold value from -128 to 127.
+ * Checks whether the next token can be translated into a valid @c signed @c char value in the default radix.
+ * The @c signed @c char can hold value from -128 to 127.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %signed char value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToSignedChar(void) const;
/**
- * Checks whether the next token can be translated into a valid %signed char value in the specified radix.
- * The signed char can hold value from -128 to 127.
+ * Checks whether the next token can be translated into a valid @c signed @c char value in the specified @c radix.
+ * The @c signed @c char can hold value from -128 to 127.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %signed char value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n
* else @c false
- * @param[in] radix The radix used to translate the token as a valid %signed char value
+ * @param[in] radix The radix to use to translate the token as a valid @c signed @c char value
*/
bool IsNextTokenConvertibleToSignedChar(int radix) const;
/**
- * Checks whether the next token can be translated into a valid %int value in the default radix.
+ * Checks whether the next token can be translated into a valid @c int value in the default radix. @n
* The signed integer can hold value from -2^31 to 2^31-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %int value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToInt(void) const;
/**
- * Checks whether the next token can be translated into a valid %int value in the specified radix.
+ * Checks whether the next token can be translated into a valid @c int value in the specified @c radix. @n
* The signed integer can hold value from -2^31 to 2^31-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %int value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n
* else @c false
- * @param[in] radix The radix used to translate the token as a valid %int value
+ * @param[in] radix The radix to use to translate the token as a valid @c int value
*/
bool IsNextTokenConvertibleToInt(int radix) const;
/**
- * Checks whether the next token can be translated into a valid %short value in the default radix.
- * The signed short can hold value from -2^15 to 2^15-1.
+ * Checks whether the next token can be translated into a valid @c short value in the default radix. @n
+ * The signed @c short can hold value from -2^15 to 2^15-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %short value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToShort(void) const;
/**
- * Checks whether the next token can be translated into a valid %short value in the specified radix.
- * The signed short can hold value from -2^15 to 2^15-1.
+ * Checks whether the next token can be translated into a valid @c short value in the specified @c radix. @n
+ * The signed @c short can hold value from -2^15 to 2^15-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %short value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n
* else @c false
- * @param[in] radix The radix used to translate the token as a valid %short value
+ * @param[in] radix The radix to use to translate the token as a valid @c short value
*/
bool IsNextTokenConvertibleToShort(int radix) const;
/**
- * Checks whether the next token can be translated into a valid %long long value.
- * The signed long can hold value from -2^63 to 2^63-1.
+ * Checks whether the next token can be translated into a valid @c long @c long value. @n
+ * The signed @c long @c long can hold value from -2^63 to 2^63-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %long long value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c long @c long value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToLongLong(void) const;
/**
- * Checks whether the next token can be translated into a valid %float value.
- * The signed float can hold a single-precision 32-bit floating number.
+ * Checks whether the next token can be translated into a valid @c float value. @n
+ * The signed @c float can hold a single-precision 32-bit floating number.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %float value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c float value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToFloat(void) const;
/**
- * Checks whether the next token can be translated into a valid %double value.
- * The signed double can hold a double-precision 64-bit floating number.
+ * Checks whether the next token can be translated into a valid @c double value. @n
+ * The signed @c double can hold a double-precision 64-bit floating number.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %double value in the current radix, @n
+ * @return @c true if the next token can be translated into a valid @c double value in the current radix, @n
* else @c false
*/
bool IsNextTokenConvertibleToDouble(void) const;
/**
- * Checks whether the next token can be translated into a valid %bool value.
- * Nothing can be converted except true/TRUE or false/FALSE
+ * Checks whether the next token can be translated into a valid @c bool value. @n
+ * Nothing can be converted except true/TRUE or false/FALSE.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid %bool value, @n
+ * @return @c true if the next token can be translated into a valid @c bool value, @n
* else @c false
*/
bool IsNextTokenConvertibleToBool(void) const;
bool HasNextLine(void) const;
/**
- * Sets the radix of the current instance of %Scanner to the specified radix
+ * Sets the radix of the current instance of %Scanner to the specified @c radix
*
* @since 2.1
- * @param[in] radix The radix used for conversion.
+ * @param[in] radix The radix to use for conversion
*
*/
void SetRadix(int radix);
* Sets the delimiter of the current instance of %Scanner to the pattern constructed from the specified delimiter.
*
* @since 2.1
- * @param[in] patternStr The delimiter to construct the pattern.
+ * @param[in] patternStr The delimiter to construct the pattern
*/
void SetDelimiter(const String& patternStr);
/**
- * Sets the delimiter of the current instance of %Scanner to the specified pattern.
+ * Sets the delimiter of the current instance of %Scanner to the specified @c pattern.
*
* @since 2.1
- * @param[in] pattern The pattern used as a delimiter.
+ * @param[in] pattern The pattern to use as a delimiter
*/
void SetDelimiter(const RegularExpression& pattern);
* Skips the pattern constructed from the specified string.
*
* @since 2.1
- * @param[in] patternStr The string to construct the pattern.
+ * @param[in] patternStr The string to construct the pattern
* @remarks If no match to the specified pattern is found at the current position, nothing is skipped.
*
- * The following example demonstrates how to use this method.
+ * The following example demonstrates how to use the %Skip() method.
*
* @code
*
void Skip(const String& patternStr);
/**
- * Skips the specified pattern.
+ * Skips the specified @c pattern.
*
* @since 2.1
- * @param[in] pattern The pattern used to skip.
+ * @param[in] pattern The pattern to use to skip
* @remarks If no match to the specified pattern is found at the current position, nothing is skipped.
*/
void Skip(const RegularExpression& pattern);
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks The method returns @c true if all the attributes in the instance are same.
+ * @remarks This method returns @c true if all the attributes in the instance are same.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
projects / platform / framework / native / appfw.git / commitdiff