update reviewed dox.
[platform/framework/native/appfw.git] / inc / FLocales.h
1 //
2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
3 //
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //     http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16
17 /**
18  * @file                FLocales.h
19  * @brief               This is the header file for the %Locales namespace.
20  *
21  * This header file contains the declarations of the %Locales namespace.
22  */
23
24 #ifndef _FLOCALES_H_
25 #define _FLOCALES_H_
26
27 #include <FLclLocale.h>
28 #include <FLclLocaleManager.h>
29 #include <FLclNumberFormatter.h>
30 #include <FLclDateTimeFormatter.h>
31 #include <FLclNumberSymbols.h>
32 #include <FLclDateTimeSymbols.h>
33 #include <FLclCalendar.h>
34 #include <FLclGregorianCalendar.h>
35 #include <FLclTimeZone.h>
36 #include <FLclCurrency.h>
37
38
39 /**
40  * @namespace   Tizen::Locales
41  * @brief               This namespace contains classes that define culture-related information.
42  *
43  * @since               2.0
44  *
45  * @remarks     @b Header @b %file: @b \#include @b <FLocales.h> @n
46  *                              @b Library: @b osp-appfw
47  *
48  *
49  * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and 
50  * formatting locale-sensitive information, such as dates, times, numbers, and time zones.
51  *
52  * Even if the list of all the available languages supported by the device is different, the localized information by 
53  * the %Locales namespace should be represented properly.
54  *
55  * For more information on the %Locales namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/locales_namespace.htm">Locales Guide</a>.
56  *
57  * The following diagram illustrates the relationships between the classes belonging to the %Locales namespace.
58  *
59  * @image html locales_using_the_apis_classdiagram.png
60  */
61
62 namespace Tizen { namespace Locales
63 {
64
65 }} // Tizen::Locales
66
67 #endif //_FLOCALES_H_