From 4c91020c930c13a27757d68fc5a88f3f2f558a09 Mon Sep 17 00:00:00 2001 From: Boyeon Date: Tue, 21 May 2019 16:38:25 +0900 Subject: [PATCH] Add explanations in the lib folder and move the explanation for result detail to the proper place --- inc/iot-device-manage-type.h | 3 +++ inc/iot-device-manage.h | 5 +---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/inc/iot-device-manage-type.h b/inc/iot-device-manage-type.h index fbbe58b..46b630e 100644 --- a/inc/iot-device-manage-type.h +++ b/inc/iot-device-manage-type.h @@ -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 diff --git a/inc/iot-device-manage.h b/inc/iot-device-manage.h index 65b5828..7c50e15 100644 --- a/inc/iot-device-manage.h +++ b/inc/iot-device-manage.h @@ -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 -- 2.7.4