updated doxygen docu, added FIXMEs, fixed headers to 80chars width.

[i3/i3] / include / table.h

diff --git a/include/table.h b/include/table.h
index 5db1cda440465a64b14390fc01d39d47c1b5f260..355839b1820a56dc1905e1bae4fb0b450672f946 100644 (file)
--- a/include/table.h
+++ b/include/table.h
@@ -25,14 +25,47 @@ extern Workspace workspaces[10];
 extern int current_col;
 extern int current_row;
 
+/** Initialize table */
 void init_table();
+
+/** Add one row to the table */
 void expand_table_rows(Workspace *workspace);
+
+/** Adds one row at the head of the table */
 void expand_table_rows_at_head(Workspace *workspace);
+
+/** Add one column to the table */
 void expand_table_cols(Workspace *workspace);
+
+/**
+ * Inserts one column at the table’s head
+ *
+ */
 void expand_table_cols_at_head(Workspace *workspace);
+
+/**
+ * Performs simple bounds checking for the given column/row
+ *
+ */
 bool cell_exists(int col, int row);
+
+/**
+ * Shrinks the table by "compacting" it, that is, removing completely empty
+ * rows/columns
+ *
+ */
 void cleanup_table(xcb_connection_t *conn, Workspace *workspace);
+
+/**
+ * Fixes col/rowspan (makes sure there are no overlapping windows)
+ *
+ */
 void fix_colrowspan(xcb_connection_t *conn, Workspace *workspace);
+
+/**
+ * Prints the table’s contents in human-readable form for debugging
+ *
+ */
 void dump_table(xcb_connection_t *conn, Workspace *workspace);
 
 #endif