doc/appfw_i18n_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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 #ifndef __TIZEN_APPFW_I18N_DOC_H__
  19 #define __TIZEN_APPFW_I18N_DOC_H__
  20
  21
  22  /**
  23  * @ingroup CAPI_APPLICATION_MODULE
  24  * @defgroup CAPI_I18N_MODULE Internationalization
  25  * @brief The Internationalization API provides functions to write multilingual applications through GNU gettext.
  26  *
  27  * @section CAPI_I18_MODULE_HEADER Required Header
  28  *   \#include <app.h>
  29  *
  30  * @section CAPI_I18N_MODULE_OVERVIEW Overview
  31  * The @ref CAPI_I18N_MODULE API provides functions to write multilingual applications through GNU gettext.
  32  * <p>
  33  * Tizen provides all the features of the GNU gettext library through the Internationalization API
  34  * and allows you to manage message catalogs from SDK.
  35  * <p>
  36  * The Internationalization API consists of i18n_get_text() for message translation
  37  * and macros to use i18n_get_text() in an easy to use form.
  38  * These macros allow you to mark strings for translation in source codes,
  39  * which are replaced with the translated strings at runtime.
  40  * <p>
  41  */
  42
  43
  44
  45 #endif /* __TIZEN_APPFW_I18N_DOC_H__ */