doc/appfw_job_scheduler_doc.h

   1 /*
   2  * Copyright (c) 2017 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_APPFW_JOB_SCHEDULER_DOC_H__
  18 #define __TIZEN_APPFW_JOB_SCHEDULER_DOC_H__
  19
  20 /**
  21  * @ingroup CAPI_APPLICATION_MODULE
  22  * @defgroup CAPI_JOB_SCHEDULER_MODULE Job scheduler
  23  * @brief The @ref CAPI_JOB_SCHEDULER_MODULE API contains the job scheduler library.
  24  *
  25  * @section CAPI_JOB_SCHEDULER_MODULE_HEADER Required Header
  26  *   \#include <job_scheduler.h>
  27  *
  28  * @section CAPI_JOB_SCHEDULER_MODULE_OVERVIEW Overview
  29  * It provides functions to define job-execution conditions. It improves the applications' performance and system health.
  30  *
  31  * @section CAPI_JOB_SCHEDULER_MODULE_FEATURE Related Features
  32  * Some job trigger events and some functions are related with the following features:
  33  * - %http://tizen.org/feature/network.wifi
  34  * - %http://tizen.org/feature/location.gps
  35  * - %http://tizen.org/feature/battery
  36  * - %http://tizen.org/feature/usb.host
  37  *
  38  * It is recommended to use features in your application for reliability.
  39  * You can check if the device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.
  40  * To ensure your application is only running on devices with specific features, please define the features in your manifest file using the manifest editor in the SDK.
  41  * 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>
  42  */
  43
  44 #endif /* __TIZEN_APPFW_JOB_SCHEDULER_DOC_H__ */