doc/feedback_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_SYSTEM_FEEDBACK_DOC_H__
  19 #define __TIZEN_SYSTEM_FEEDBACK_DOC_H__
  20
  21 /**
  22  * @ingroup CAPI_SYSTEM_FRAMEWORK
  23  * @defgroup CAPI_SYSTEM_FEEDBACK_MODULE Feedback
  24  * @brief  The FEEDBACK API provides functions to play sound or vibration associated with properties.
  25  *
  26  * @section CAPI_SYSTEM_FEEDBACK_MODULE_HEADER Required Header
  27  *   \#include <feedback.h>
  28  *
  29  * @section CAPI_SYSTEM_FEEDBACK_MODULE_OVERVIEW Overview
  30  * The FEEDBACK API is responsible for playing simple sound and vibration.
  31  * It plays sound using mm-sound library and vibration with system framework.
  32
  33  * @section CAPI_SYSTEM_FEEDBACK_FEATURE Related Features
  34  * This API is related with the following features:\n
  35  * - %http://tizen.org/feature/feedback.vibration\n
  36  *
  37  * It is recommended to design feature related codes in your application for reliability.\n
  38  *
  39  * 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
  40  *
  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  *
  43  * 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 List</b>.</a>
  44  *
  45  *
  46  */
  47
  48 #endif /* __TIZEN_SYSTEM_FEEDBACK_DOC_H__ */