Use atomic operation for Reference counting
[platform/framework/native/appfw.git] / inc / FBaseColStlConverter.h
index 14e2e83..6f92448 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -44,11 +43,11 @@ class IMultiMap;
 
 /**
  *     @class  StlConverter
- *     @brief  This class provides static methods to convert Tizen Collection to STL Container and vice versa.
+ *     @brief  This class provides static methods to convert %Tizen Collection to STL Container and vice versa.
  *
  *     @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
@@ -66,7 +65,7 @@ class IMultiMap;
  *             // 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));
@@ -147,8 +146,8 @@ public:
        }
 
        /**
-        * 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
         *
@@ -162,8 +161,8 @@ public:
        }
 
        /**
-        * 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
         *
@@ -177,8 +176,8 @@ public:
        }
 
        /**
-        * 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
         *
@@ -192,8 +191,8 @@ public:
        }
 
        /**
-        * 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
         *
@@ -218,11 +217,11 @@ public:
         * @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()
@@ -262,11 +261,11 @@ public:
         * @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()
@@ -303,11 +302,11 @@ public:
         * @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()
@@ -347,11 +346,11 @@ public:
         * @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()