Fix the descriptions 87/152487/6
authorHwankyu Jhun <h.jhun@samsung.com>
Tue, 26 Sep 2017 08:00:37 +0000 (17:00 +0900)
committerHwankyu Jhun <h.jhun@samsung.com>
Tue, 26 Sep 2017 08:33:38 +0000 (17:33 +0900)
Change-Id: I912e4a77a610fc7188ad6e23571ef4e337b5c7b7
Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>
doc/appfw_job_scheduler_doc.h
include/job_error.h
include/job_info.h
include/job_scheduler.h

index 211f172..62d8e15 100755 (executable)
  * - http://tizen.org/feature/battery
  * - http://tizen.org/feature/usb.host
  *
- * It is recommended to design feature related code in your application for reliability.
- * You can check if the device supports the related features for this API by using @ref CAPI_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
- * 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.
- * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
+ * It is recommended to use features in your application for reliability.
+ * You can check if the device supports the related features for this API by using @ref CAPI_SYSTEM_INFO_MODULE, and control your application's actions accordingly.
+ * 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.
+ * More details on using features in your application can be found in <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  */
 
 #endif /* __TIZEN_APPFW_JOB_SCHEDULER_DOC_H__ */
index a58aa50..3d5f6b5 100644 (file)
@@ -24,7 +24,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup CAPI_APPLICATION_MODULE
+ * @addtogroup CAPI_JOB_SCHEDULER_MODULE
  * @{
  */
 
index 27bbf5e..cf4a6d2 100644 (file)
@@ -24,7 +24,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup CAPI_APPLICATION_MODULE
+ * @addtogroup CAPI_JOB_SCHEDULER_MODULE
  * @{
  */
 
index 3ff74cd..ff3ae46 100644 (file)
@@ -25,7 +25,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup CAPI_APPLICATION_MODULE
+ * @addtogroup CAPI_JOB_SCHEDULER_MODULE
  * @{
  */
 
@@ -150,7 +150,7 @@ int job_scheduler_cancel(const char *job_id);
  * @brief Cancels all scheduled jobs.
  * @since_tizen 4.0
  * @return @c 0 on success,
- *         otherwise a nagative error value
+ *         otherwise a negative error value
  * @retval #JOB_ERROR_NONE              Successful
  * @retval #JOB_ERROR_NOT_INITIALIZED   Not initialized
  * @retval #JOB_ERROR_IO_ERROR          IO error
@@ -160,7 +160,7 @@ int job_scheduler_cancel(const char *job_id);
 int job_scheduler_cancel_all(void);
 
 /**
- * @brief Notify that the job is finished.
+ * @brief Notifies that the job is finished.
  * @since_tizen 4.0
  * @remarks If the job has been launched, the system kept awake for a while.
  *          It is highly recommended to notify that the job is done,
@@ -197,6 +197,7 @@ int job_scheduler_foreach_job(job_scheduler_foreach_job_cb callback, void *user_
 /**
  * @brief Adds job service handler for receiving the information of the scheduled job.
  * @since_tizen 4.0
+ * @remarks The @a job_service handle should be released using job_scheduler_service_remove().
  * @param[in]   job_id          The ID of the job
  * @param[in]   callback        The set of callback functions to handle jobs
  * @param[in]   user_data       The user data to be passed to the callback function
@@ -225,7 +226,7 @@ int job_scheduler_service_add(const char *job_id, job_service_callback_s *callba
  *         otherwise a negative error value
  * @retval #JOB_ERROR_NONE              Successful
  * @retval #JOB_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #JOB_ERROR_NOT_INITIALIZED   Not initialzed
+ * @retval #JOB_ERROR_NOT_INITIALIZED   Not initialized
  * @pre    job_scheduler_init() MUST be called.
  * @see    job_scheduler_init()
  * @see    job_scheduler_service_add()