Add doxygen comment to explain the support for further STL iterator concept.

[platform/framework/native/appfw.git] / inc / FBaseColStlConverter.h

diff --git a/inc/FBaseColStlConverter.h b/inc/FBaseColStlConverter.h
index a0d979a..1626657 100644 (file)
--- a/inc/FBaseColStlConverter.h
+++ b/inc/FBaseColStlConverter.h
@@ -84,6 +84,12 @@ class IMultiMap;
  *             // call SomeNativeAPI(pList2.get());
  *     }
  *     @endcode
+ *     @remarks        Before %Tizen 3.0, iterators managed by %StlConverter only met the requirements of the STL InputIterator concept
+ *                             due to the limitation of the uderlying %Tizen collection. But from %Tizen 3.0, these iterators support further STL iterator concept like below.
+ *                             Both IteratorT and RandomIteratorT support STL OutputIterator concept which can be dereferenced as an lvalue. It's the mutable iterator.
+ *                             - PairIteratorT supports STL constant ForwardIterator.
+ *                             - IteratorT supports STL mutable BidirectionalIterator.
+ *                             - RandomIteratorT supports STL mutable RandomAccessIterator.
  */
 
 class StlConverter