From 51806fa7b64cdd3430deaa14994a5b399a7b8cef Mon Sep 17 00:00:00 2001
From: Yanbo Zhou <yanbo.zhou@intel.com>
Date: Mon, 16 Apr 2018 15:24:13 +0800
Subject: [PATCH] include/event.h: add comments for callback functions

Change-Id: Ie29d7cc3e155628f92c5ffae9d0b3e8cb0989ebe
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/407704
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: GangCao <gang.cao@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
---
 include/spdk/event.h | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/include/spdk/event.h b/include/spdk/event.h
index ed8a8b686..784aedbcb 100644
--- a/include/spdk/event.h
+++ b/include/spdk/event.h
@@ -51,6 +51,12 @@
 extern "C" {
 #endif
 
+/**
+ * Event handler function.
+ *
+ * \param arg1 Argument 1.
+ * \param arg2 Argument 2.
+ */
 typedef void (*spdk_event_fn)(void *arg1, void *arg2);
 
 /**
@@ -63,8 +69,17 @@ struct spdk_event;
  */
 struct spdk_poller;
 
+/**
+ * Callback function for customized shutdown handling of application.
+ */
 typedef void (*spdk_app_shutdown_cb)(void);
-typedef void (*spdk_sighandler_t)(int);
+
+/**
+ * Signal handler fucntion.
+ *
+ * \param signal Signal number.
+ */
+typedef void (*spdk_sighandler_t)(int signal);
 
 #define SPDK_DEFAULT_RPC_ADDR "/var/tmp/spdk.sock"