From 9a9bef0a9aec8d4710823c5879c515304bcc2e29 Mon Sep 17 00:00:00 2001
From: Yanbo Zhou <yanbo.zhou@intel.com>
Date: Mon, 16 Apr 2018 12:23:59 +0800
Subject: [PATCH] include/copy_engine.h: add comments for callback functions

Change-Id: Id731686e21df1bc2b077f729ab395719b437e4de
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/407689
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
---
 include/spdk/copy_engine.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/include/spdk/copy_engine.h b/include/spdk/copy_engine.h
index 9f9ba346e..06dc15604 100644
--- a/include/spdk/copy_engine.h
+++ b/include/spdk/copy_engine.h
@@ -44,7 +44,19 @@
 extern "C" {
 #endif
 
+/**
+ * Copy operation callback.
+ *
+ * \param ref 'copy_req' passed to the corresponding spdk_copy_submit() call.
+ * \param status 0 if it completed successfully, or negative errno if it failed.
+ */
 typedef void (*spdk_copy_completion_cb)(void *ref, int status);
+
+/**
+ * Copy engine finish callback.
+ *
+ * \param cb_arg Callback argument.
+ */
 typedef void (*spdk_copy_fini_cb)(void *cb_arg);
 
 struct spdk_io_channel;