Add doxygen comment to explain the support for further STL iterator concept. 20/13320/1
authordahyeong.kim <dahyeong.kim@samsung.com>
Tue, 3 Dec 2013 05:04:37 +0000 (14:04 +0900)
committerdahyeong.kim <dahyeong.kim@samsung.com>
Tue, 3 Dec 2013 05:27:30 +0000 (14:27 +0900)
Change-Id: Idac3c035bc309c565d8358cad199c32a4c272f31
Signed-off-by: dahyeong.kim <dahyeong.kim@samsung.com>
inc/FBaseColStlConverter.h

index a0d979a..1626657 100644 (file)
@@ -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