CONTRIBUTING: document people should use the `next` branch

[i3/i3] / include / match.h

diff --git a/include/match.h b/include/match.h
index 2786c66a8be7792cd25485f48ca7ea971b8d0667..09975cac20fe644162930e08ea25742e1d12644f 100644 (file)
--- a/include/match.h
+++ b/include/match.h
@@ -1,5 +1,17 @@
-#ifndef _MATCH_H
-#define _MATCH_H
+/*
+ * vim:ts=4:sw=4:expandtab
+ *
+ * i3 - an improved dynamic tiling window manager
+ * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ *
+ * A "match" is a data structure which acts like a mask or expression to match
+ * certain windows or not. For example, when using commands, you can specify a
+ * command like this: [title="*Firefox*"] kill. The title member of the match
+ * data structure will then be filled and i3 will check each window using
+ * match_matches_window() to find the windows affected by this command.
+ *
+ */
+#pragma once
 
 /*
  * Initializes the Match data structure. This function is necessary because the
@@ -28,4 +40,8 @@ void match_copy(Match *dest, Match *src);
  */
 bool match_matches_window(Match *match, i3Window *window);
 
-#endif
+/**
+ * Frees the given match. It must not be used afterwards!
+ *
+ */
+void match_free(Match *match);