doc/shortcut_doc.h

   1 /*
   2  * Copyright (c) 2011 - 2015 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
  19 #ifndef __SHORTCUT_DOC_H__
  20 #define __SHORTCUT_DOC_H__
  21
  22
  23 /**
  24  * @ingroup CAPI_APPLICATION_FRAMEWORK
  25  * @defgroup SHORTCUT_MODULE Shortcut
  26  * @brief To enhance the Add to home feature.
  27  *        - The other for the application developers who should implement the Add to home feature.
  28  * @section SHORTCUT_MODULE_HEADER Required Header
  29  * \#include <shortcut_manager.h>
  30  *
  31  * @section SHORTCUT_MODULE_OVERVIEW Overview
  32  * It provides function of creating shortcut.
  33  * Developers can use the "shortcut_add_to_home" API to create their shortcut to a home screen.
  34
  35  * @section CAPI_SHORTCUT_MODULE_FEATURE Related Features
  36  * This API is related with the following features:\n
  37  * - %http://tizen.org/feature/shortcut\n
  38  *
  39  * It is recommended to design feature related codes in your application for reliability.\n
  40  * 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
  41  * 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
  42  * 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>
  43  */
  44
  45
  46 #endif /* __SHORTCUT_DOC_H__ */