Add more documentation to functions/header files

2010-07-13 11:35:05 +02:00
parent 60bdf87862
commit 7415f14448
10 changed files with 317 additions and 3 deletions
--- a/include/match.h
+++ b/include/match.h
@ -1,7 +1,17 @@
 #ifndef _MATCH_H
 #define _MATCH_H

+/**
+ * Check if a match is empty. This is necessary while parsing commands to see
+ * whether the user specified a match at all.
+ *
+ */
 bool match_is_empty(Match *match);
+
+/**
+ * Check if a match data structure matches the given window.
+ *
+ */
 bool match_matches_window(Match *match, i3Window *window);

 #endif