doc/sticker_doc.h

   1 /*
   2  * Copyright (c) 2019 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 #ifndef __TIZEN_UIX_STICKER_DOC_H__
  18 #define __TIZEN_UIX_STICKER_DOC_H__
  19
  20
  21 /**
  22  * @ingroup CAPI_UIX_FRAMEWORK
  23  * @defgroup CAPI_UIX_STICKER_MODULE Sticker
  24  * @brief The @ref CAPI_UIX_STICKER_MODULE API provides the functions to manage and retrieve sticker information.
  25  *
  26  * @section CAPI_UIX_STICKER_MODULE_OVERVIEW Overview
  27  * Using sticker library, a sticker application can provide sticker information to applications that want to read the sticker information as the standard specification.
  28  * A <a href="https://en.wikipedia.org/wiki/Sticker_(messaging)">sticker</a> is an image (possibly animated) that is used in an IM conversation.
  29  * The Sticker API covers the exchange of sticker data between applications. How the images are used depends on a particular sticker consumer application.
  30  *
  31  * @section CAPI_UIX_STICKER_MODULE_FEATURE Related Feature
  32  * This API is related with the following feature:\n
  33  *  - %http://tizen.org/feature/ui_service.sticker
  34  *
  35  * It is recommended to design feature related codes in your application for reliability.\n
  36  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  37  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  38  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  39  *
  40  */
  41
  42
  43 #endif /* __TIZEN_UIX_STICKER_DOC_H__ */