//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
- * list.RemoveAll();
+ * // 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()
*
* @return An error code
* @param[in] capacity The number of elements @n
- * The default capacity is @c 10.
+ * The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the specified @c capacity is negative.
/**
* 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
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection A collection to add
* @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 @c collection is modified during the operation of this method.
* @since 2.0
*
* @return An error code
- * @param[in] pObj An pointer to object to add
+ * @param[in] pObj An pointer to object to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
/**
- * 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
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection A collection to add
* @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 @c collection is modified during the operation of this method.
*
* @since 2.0
*
- * @return An instance of the IBidirectionalEnumerator derived class, @n
- * else @c null if some exception occurs
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
- * to iterate over a collection (an instance of the IList derived class).
- * The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumerator
+ * @return An instance of the IBidirectionalEnumerator derived class, @n
+ * else @c null if some exception occurs
+ * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
+ * to iterate over a collection (an instance of the IList derived class).
+ * The specific error code can be accessed using GetLastResult() method.
+ * @see Tizen::Base::Collection::IBidirectionalEnumerator
*/
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
+ * @param[in] index The index of the object in the calling list to read
* @exception E_SUCCESS The method is successful.
* @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.
/**
- * 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.
* - The specified index is outside the bounds of the data structure. @n
* - The specified @c startIndex is either equal to or greater than the number of elements 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.
+ * or less than @c 0.
* @remarks The IList stores just the pointers to the elements in the list, not the elements themselves.
* The specific error code can be accessed using the GetLastResult() method.
*/
* @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
- * 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.
+ * 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()
*/
virtual result IndexOf(const Object& obj, int startIndex, int& index) const;
* - The specified index is outside the bounds of the data structure. @n
* - The specified @c startIndex is either equal to or greater than the number of elements 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.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * or less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const;
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to insert
+ * @param[in] pObj The pointer to object to insert
* @param[in] index The index at which the object must be inserted
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to remove
+ * @param[in] obj An object to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
* @see Add()
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object must be removed
* @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 or less than @c 0.
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to remove from this list
+ * @param[in] collection The collection to remove from this list
* @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 @c collection is modified during the operation of this method.
/**
* 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
*
* @return An error code
- * @param[in] pObj An pointer to object to set
- * @param[in] index The index at which the object must be set
+ * @param[in] pObj An pointer to object to set
+ * @param[in] index The index at which the object must be set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
* @return An error code
* @param[in] newCapacity The new capacity of this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the @c newCapacity is negative.
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
+ * the @c newCapacity is negative.
* @remarks When the new capacity is less than the current capacity, the elements
* within the truncated memory are not destroyed.
* @see Construct()
* @since 2.0
*
* @return An error code
- * @param[in] comparer The IComparer implementation to use when comparing elements
+ * @param[in] comparer The IComparer implementation to use when comparing elements
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*/
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
- * else @c false
+ * @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.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
* the @c collection is modified during the operation of this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @remarks If the given @c collection is empty, this method will return @c true.
- * @see Contains()
+ * @see Contains()
*/
virtual bool ContainsAll(const ICollection& collection) const;
*
* @since 2.0
* @return @c true if it is an %ArrayList, @n
- * else @c false if it is a LinkedList.
+ * 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;
* Sorts the specified sub-list.
*
* @return An error code
- * @param[in] startIndex The starting point of the sub-list to sort
- * @param[in] endIndex The end point of the sub-list to sort
+ * @param[in] startIndex The starting point of the sub-list to sort
+ * @param[in] endIndex The end point of the sub-list to sort
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the comparer has failed to compare the elements.
*
* @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);
projects / platform / framework / native / appfw.git / blobdiff