Merge refined doxygen comments of Base header files
[platform/framework/native/appfw.git] / inc / FBaseCol.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17
18 /**
19  * @file                FBaseCol.h
20  * @brief               This is the header file for the %Collection namespace.
21  *
22  * This header file contains the declarations and descriptions of the %Collection namespace.
23  *
24  */
25
26 #ifndef _FBASE_COL_H_
27 #define _FBASE_COL_H_
28
29 #include <FBaseColArrayList.h>
30 #include <FBaseColLinkedList.h>
31 #include <FBaseColQueue.h>
32 #include <FBaseColStack.h>
33 #include <FBaseColHashMap.h>
34 #include <FBaseColMapEntry.h>
35 #include <FBaseColIHashCodeProvider.h>
36 #include <FBaseColMultiHashMap.h>
37 #include <FBaseColIBidirectionalEnumerator.h>
38 #include <FBaseColIBidirectionalEnumeratorT.h>
39 #include <FBaseColIComparerT.h>
40 #include <FBaseColArrayListT.h>
41 #include <FBaseColLinkedListT.h>
42 #include <FBaseColQueueT.h>
43 #include <FBaseColStackT.h>
44 #include <FBaseColHashMapT.h>
45 #include <FBaseColMultiHashMapT.h>
46 #include <FBaseColMapEntryT.h>
47 #include <FBaseColAllElementsDeleter.h>
48 #include <FBaseColStlConverter.h>
49 #include <FBaseColIteratorT.h>
50 #include <FBaseColPairIteratorT.h>
51 #include <FBaseColRandomIteratorT.h>
52
53 /**
54  * @namespace   Tizen::Base::Collection
55  * @brief               This namespace contains classes and interfaces for various collections.
56  * @since 2.0
57  *
58  * @remarks     @b Header @b %file: @b \#include @b <FBase.h> @n
59  *                              @b Library : @b osp-appfw
60  *
61  * The %Collection namespace contains classes and interfaces for various collections
62  * (such as lists, maps, stacks, and queues), which are an aggregation of similar objects.
63  *
64  * For more information on the %Base::Collection namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_namespace.htm">Collection</a>.
65  *
66  * The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace.
67  *
68  *  @image html base_collection_namespace_obj_based_classdiagram.png
69  *
70  *      @image html base_collection_namespace_template_based_classdiagram.png
71  *
72  *
73  *
74  *
75  */
76
77 namespace Tizen { namespace Base { namespace Collection
78 {
79
80 }}} // Tizen::Base::Collection
81
82 #endif // _FBASE_COL_H_