Merge pull request #2103 from Airblader/bug-2091

[i3/i3] / include / match.h

diff --git a/include/match.h b/include/match.h
index 6c0694efeace588462c69fec845d00ba69188261..64a4f22bd8b4e5174d87ad228c228587970389f8 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 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
@@ -34,4 +46,8 @@ bool match_matches_window(Match *match, i3Window *window);
  */
 void match_free(Match *match);
 
-#endif
+/**
+ * Interprets a ctype=cvalue pair and adds it to the given match specification.
+ *
+ */
+void match_parse_property(Match *match, const char *ctype, const char *cvalue);