Add explanation about JSON Schema definition / example for request / detail in idm_co...

diff --git a/inc/iot-device-manage.h b/inc/iot-device-manage.h
index 8434122..65b5828 100644 (file)
--- a/inc/iot-device-manage.h
+++ b/inc/iot-device-manage.h
@@ -123,7 +123,13 @@ 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
- *          This is not thread safe.
+ * @remarks Format of @p request (JSON string) 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
  * @param[in] detail The details for setting @p cmd