Resolve documentation FIXMEs, remove an unnecessary struct

[i3/i3] / include / config.h

diff --git a/include/config.h b/include/config.h
index cbfeaf1b4f2d02004bc8b4387765fe6303f2393d..140db5ab2a44d5c886bfa2ecbe68189311e6de33 100644 (file)
--- a/include/config.h
+++ b/include/config.h
@@ -12,8 +12,6 @@
  *
  */
 
-/* FIXME: this file lacks documentation */
-
 #ifndef _CONFIG_H
 #define _CONFIG_H
 
@@ -22,12 +20,22 @@
 typedef struct Config Config;
 extern Config config;
 
+/**
+ * Part of the struct Config. It makes sense to group colors for background,
+ * border and text as every element in i3 has them (window decorations, bar).
+ *
+ */
 struct Colortriple {
         uint32_t border;
         uint32_t background;
         uint32_t text;
 };
 
+/**
+ * Holds a user-assigned variable for parsing the configuration file. The key
+ * is replaced by value in every following line of the file.
+ *
+ */
 struct Variable {
         char *key;
         char *value;
@@ -35,6 +43,11 @@ struct Variable {
         SLIST_ENTRY(Variable) variables;
 };
 
+/**
+ * Holds part of the configuration (the part which is not already in dedicated
+ * structures in include/data.h).
+ *
+ */
 struct Config {
         const char *terminal;
         const char *font;