Add explanations in the lib folder and move the explanation for result detail to...
authorBoyeon <boyeon.son@samsung.com>
Tue, 21 May 2019 07:38:25 +0000 (16:38 +0900)
committer손보연/Tizen Platform Lab(SR)/Engineer/삼성전자 <boyeon.son@samsung.com>
Wed, 22 May 2019 03:59:31 +0000 (12:59 +0900)
inc/iot-device-manage-type.h
inc/iot-device-manage.h

index fbbe58b..46b630e 100644 (file)
@@ -82,6 +82,9 @@ typedef struct __idm_command_h *idm_command_h;
 /**
 * @brief Type definition of result callback function
 * @since_tizen 5.0
+* @remarks Format of @p detail for receiving result detail depends on @p cmd \n
+*          #IDM_CMD_GET_TASKINFO refers to 'schema/taskResult.json' as JSON schema definition and 'schema/taskResultExample.json' as example\n
+*          #IDM_CMD_GET_LOG_ARCHIVE refers to 'schema/logArchiveResult.json' as JSON schema definition and 'schema/logArchiveResultExample.json' as example\n
 * @param command Command handle
 * @param result Enum value for result
 * @param reason Enum value for reason
index 65b5828..7c50e15 100644 (file)
@@ -123,12 +123,9 @@ int idm_command_get_type(idm_command_h command, idm_cmd_type_e *type);
  * @remarks Required privilege depends on @p cmd \n
  *          #IDM_CMD_REBOOT requires privilege http://tizen.org/privilege/reboot \n
  *          #IDM_CMD_GET_TASKINFO requires privilege http://tizen.org/privilege/systemmonitor \n
- * @remarks Format of @p request (JSON string) for sending cmd request depends on @p cmd \n
+ * @remarks Format of @p detail for sending cmd request depends on @p cmd \n
  *          #IDM_CMD_GET_TASKINFO refers to 'schema/taskRequest.json' as JSON schema definition and 'schema/taskRequestExample.json' as example\n
  *          #IDM_CMD_GET_LOG_ARCHIVE refers to 'schema/logArchiveRequest.json' as JSON schema definition and 'schema/logArchiveRequestExample.json' as example\n
- * @remarks Format of @p detail (JSON string) for receiving result detail depends on @p cmd \n
- *          #IDM_CMD_GET_TASKINFO refers to 'schema/taskResult.json' as JSON schema definition and 'schema/taskResultExample.json' as example\n
- *          #IDM_CMD_GET_LOG_ARCHIVE refers to 'schema/logArchiveResult.json' as JSON schema definition and 'schema/logArchiveResultExample.json' as example\n
  * @remarks This is not thread safe.
  * @param[in] command The idm_command handle
  * @param[in] cmd The command for getting information