Merge branch 'master' into next

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

diff --git a/i3bar/include/ipc.h b/i3bar/include/ipc.h
index 278077e0d105a645645412a81fa9d5daf0bb40b7..c357be89e8efc7087a57a8a9a1cbc7e25b495607 100644 (file)
--- a/i3bar/include/ipc.h
+++ b/i3bar/include/ipc.h
@@ -1,11 +1,38 @@
-#ifndef IPC_H_
-#define IPC_H_
+/*
+ * vim:ts=4:sw=4:expandtab
+ *
+ * i3bar - an xcb-based status- and ws-bar for i3
+ * © 2010-2012 Axel Wagner and contributors (see also: LICENSE)
+ *
+ * ipc.c: Communicating with i3
+ *
+ */
+#pragma once
 
-#include <ev.h>
 #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);
-int i3_send_msg(uint32_t type, const char* payload);
-void subscribe_events();
 
-#endif
+/*
+ * Destroy the connection to i3.
+ *
+ */
+void destroy_connection(void);
+
+/*
+ * 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(void);