Add comments

[i3/i3] / i3bar / include / ipc.h

diff --git a/i3bar/include/ipc.h b/i3bar/include/ipc.h
index b3760d2ab1f863b0c7e862505742c11d503d3d13..c91960445f1bb8210c1774207571f5347a890853 100644 (file)
--- a/i3bar/include/ipc.h
+++ b/i3bar/include/ipc.h
@@ -3,8 +3,24 @@
 
 #include <stdint.h>
 
+/*
+ * Initiate a connection to i3.
+ * socket-path must be a valid path to the ipc_socket of i3
+ *
+ */
 int init_connection(const char *socket_path);
+
+/*
+ * Sends a Message to i3.
+ * type must be a valid I3_IPC_MESSAGE_TYPE (see i3/ipc.h for further information)
+ *
+ */
 int i3_send_msg(uint32_t type, const char* payload);
+
+/*
+ * Subscribe to all the i3-events, we need
+ *
+ */
 void subscribe_events();
 
 #endif