improving style and docs

1 files changed, 11 insertions, 0 deletions

diff --git a/src/include/gnunet_signal_lib.h b/src/include/gnunet_signal_lib.h
index af1ec0de4..e386ccc0e 100644
--- a/src/include/gnunet_signal_lib.h
+++ b/src/include/gnunet_signal_lib.h
@@ -35,6 +35,10 @@ extern "C"
 #endif
 #endif
 
+/**
+ * Context created when a signal handler is installed;
+ * can be used to restore it to the previous state later.
+ */
 struct GNUNET_SIGNAL_Context;
 
 /**
@@ -50,6 +54,10 @@ typedef void (*GNUNET_SIGNAL_Handler) (void);
 /**
  * Install a signal handler that will be run if the
  * given signal is received.
+ *
+ * @param signal the number of the signal
+ * @param handler the function to call
+ * @return context that can be used to restore, NULL on error
  */
 struct GNUNET_SIGNAL_Context *GNUNET_SIGNAL_handler_install (int signal,
                                                              GNUNET_SIGNAL_Handler
@@ -57,6 +65,9 @@ struct GNUNET_SIGNAL_Context *GNUNET_SIGNAL_handler_install (int signal,
 
 /**
  * Uninstall a previously installed signal hander.
+ *
+ * @param ctx context that was returned when the
+ *            signal handler was installed
  */
 void GNUNET_SIGNAL_handler_uninstall (struct GNUNET_SIGNAL_Context *ctx);