X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColStlConverter.h;h=ccb532854f9dfb3ecd6b2d02cb1c662061243bd6;hb=102d9124a6981de495cb23e8bd98c2de322960fb;hp=1626657bcf9ba91ff24aa0ff2ae859032d418b71;hpb=0772fcc0a8baea86cc58aa2e236a1c880d4cff6b;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColStlConverter.h b/inc/FBaseColStlConverter.h index 1626657..ccb5328 100644 --- a/inc/FBaseColStlConverter.h +++ b/inc/FBaseColStlConverter.h @@ -280,23 +280,24 @@ public: } /** - * Gets an ArrayList instance from the begin and end iterators of STL container. + * Gets an ArrayList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the ArrayList instance, @n - * else @c std::unique_ptr< ArrayList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< ArrayList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the 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 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. - * 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. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -324,23 +325,24 @@ public: } /** - * Gets a LinkedList instance from the begin and end iterators of STL container. + * Gets a LinkedList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the LinkedList instance @n - * else @c std::unique_ptr< LinkedList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< LinkedList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the 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 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. - * 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. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -365,23 +367,24 @@ public: } /** - * Gets a HashMap instance from the begin and end iterators of STL container. + * Gets a HashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the HashMap instance @n - * else @c std::unique_ptr< HashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< HashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the 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 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. - * 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. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -409,23 +412,24 @@ public: } /** - * Gets a MultiHashMap instance from the begin and end iterators of STL container. + * Gets a MultiHashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the MultiHashMap instance @n - * else @c std::unique_ptr< MultiHashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< MultiHashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the 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 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. - * 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. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter()