* Adds the specified object to the list.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Add(Object* pObj).
* @since 2.0
*
* @param[in] obj The object to add
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks In a collection of contiguous elements, such as a list, the elements
- * that follow the insertion point move down to accommodate the new element.
+ * @remarks
+ * - In a collection of contiguous elements, such as a list, the elements
+ * that follow the insertion point move down to accommodate the new element. @n
* If the collection is indexed, the indexes of the elements that are moved
- * are also updated. This behavior does not apply to collections where
+ * are also updated. @n
+ * This behavior does not apply to collections where
* elements are conceptually grouped into buckets, such as a hashtable.
- * This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * - This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see Remove()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to add
+ * @param[in] pObj A pointer to the object to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks In a collection of contiguous elements, such as a list, the elements
- * that follow the insertion point move down to accommodate the new element.
+ * @remarks
+ * - In a collection of contiguous elements, such as a list, the elements
+ * that follow the insertion point move down to accommodate the new element. @n
* If the collection is indexed, the indexes of the elements that are moved
- * are also updated. This behavior does not apply to collections where
+ * are also updated. @n
+ * This behavior does not apply to collections where
* elements are conceptually grouped into buckets, such as a hashtable.
- * This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * - This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pObj) = 0;
/**
- * Adds the elements of the specified collection to the end of the list.
+ * Adds the elements of the specified @c collection to the end of the list.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to add to 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 specified @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see RemoveItems()
*/
virtual result AddItems(const ICollection& collection) = 0;
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result IndexOf(const Object& obj, int& index) const = 0;
* Inserts an object at the specified location in the list.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use InsertAt(const Object* pObj, int index).
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] obj The object to insert
+ * @param[in] index The index at which the object is 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
- * the @c index is greater than the number of elements in the list or less than @c 0.
- * @remarks If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements in the list.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - If the @c index equals the number of elements in the list, the new element
* is added at the end of the list.
- * This method performs a shallow copy. It inserts the pointer only; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer only and not the element itself.
* @see Add(Object*)
* @see RemoveAt()
* @endif
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] pObj A pointer to the object to insert
+ * @param[in] index The index at which the object is inserted
* @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
- * the @c index is greater than the number of elements in the list or less than @c 0.
- * @remarks If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements in the list.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - If the @c index equals the number of elements in the list, the new element
* is added at the end of the list.
- * This method performs a shallow copy. It inserts the pointer only; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer only and not the element itself.
* @see Add(Object*)
* @see RemoveAt()
*/
virtual result InsertAt(Object* pObj, int index) = 0;
/**
- * Searches for an object starting from the specified index. @n
- * Gets the index of the object if found.
+ * Searches for an object starting from the specified @c index. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * 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
- * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int& index) const = 0;
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @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 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.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const = 0;
/**
- * Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Searches for the last occurrence of an object in the list. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Object& obj, int& index) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The starting index at which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The starting index at which the collection is 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
- * the @c startIndex is greater than the number of elements in the list or less than @c 0.
- * @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 If the @c startIndex equals the number of elements in the list, the new elements
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - If the @c startIndex is equal to the number of elements in the list, the new elements
* are added at the end of the list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see RemoveItems()
* @see AddItems()
*/
* @since 2.0
*
* @return The object at the specified location, @n
- * else @c null if the @c index is not valid
- * @param[in] index The index of the object to get
+ * else @c null if the @c index invalid
+ * @param[in] index The index of the object to get
* @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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
* @since 2.0
*
* @return The object at the specified location, @n
- * else @c null if the @c index is not valid
+ * else @c null if the @c index invalid
* @param[in] index The index of the object to get
* @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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
*
* @since 2.0
*
- * @return A pointer to an %IList with elements lying within the specified range, @n
+ * @return A pointer to the %IList that contains elements lying within the specified range, @n
* else @c null if an exception occurs
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @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 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 in the list starting from @c startIndex
- * 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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements in the list starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @remarks
+ * - The %IList stores just the pointers to the elements in the list and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IList* GetItemsN(int startIndex, int count) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to remove
+ * @param[in] obj The object to remove
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been 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
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - Remove(obj, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @return An error code
* @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add(Object*)
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] index The index at which the object is removed
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is 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
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAt(index, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @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 is 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 in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
*/
virtual result RemoveAt(int index) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements in the range
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements in the range
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @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 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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is 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
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveItems(startIndex, count, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements in the range
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements in the range
* @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 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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @see AddItems()
*/
virtual result RemoveItems(int startIndex, int count) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to be removed from this list
+ * @param[in] collection The collection to remove from this list
* @param[in] forceDeletion Set to @c true to deallocate the object, @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
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - 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
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveItems(collection, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the elements from the list that are common to the specified collection.
+ * Removes all the elements from the list that are common to the specified @c collection.
*
* @since 2.0
*
* @return An error code
* @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 specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
/**
* Removes all the object pointers in the collection. @n
- * If the deallocate param is set to @c true, it removes all the objects in the collection. @n
+ * If @c forceDeletion is set to @c true, it removes all the objects from the collection. @n
* This method can be called just before deleting the collection.
*
* @since 2.0
* @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
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAll(@b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the object pointers in the collection. @n
+ * Removes all the object pointers from the collection. @n
* This method can be called just before deleting the collection.
*
* @since 2.0
virtual void RemoveAll(void) = 0;
/**
- * 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] obj The new object
- * @param[in] index The index at which the new object must be set
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] obj The new object
+ * @param[in] index The index at which the new object is set
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @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.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is 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
- * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting.
* - SetAt(obj, index, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * 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 The pointer to new object
- * @param[in] index The index at which the new object must be set
+ * @param[in] pObj A pointer to the new object
+ * @param[in] index The index at which the new object is 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
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(Object* pObj, int index) = 0;
/**
- * Sorts the elements of this list using the comparer provided.
+ * Sorts the elements of the list using the @c comparer provided.
*
* @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 the elements
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*/
/**
* @if OSPDEPREC
- * 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.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed to boolean and this method returns the result.
* Instead of using this method, use bool ContainsAll(const ICollection& collection).
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to check for containment in this list
- * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to check for containment in this list
+ * @param[out] out Set to @c true if the list contains all the elements of the specified 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
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the given @c collection is empty, the @c out parameter is set to @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the given @c collection is empty, then @c out is set to @c true.
* @see Contains()
* @endif
*/
}
/**
- * 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
+ * else @c false
* @param[in] collection The collection to check for containment in 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 specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - If the given @c collection is empty, this method will return @c true.
+ * - If the given @c collection is empty, this method returns @c true.
* @see Contains()
*/
virtual bool ContainsAll(const ICollection& collection) const = 0;
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
*
* @since 2.0
*
- * @return A pointer to a bidirectional enumerator interface of the %IList derived class, @n
+ * @return A pointer to the bidirectional enumerator interface of the %IList derived class, @n
* else @c null if an exception occurs
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
+ * @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
+ * - The specific error code can be accessed using GetLastResult() method.
*/
virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const = 0;
/**
- * This method is for distinguishing between ArrayList and LinkedList.
+ * Checks whether the instance is an ArrayList or a LinkedList.
*
* @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
{
projects / platform / framework / native / appfw.git / blobdiff