Add documentation for workspace_get()

diff --git a/include/workspace.h b/include/workspace.h
index 6a17f5974738d5718b0c7fc92b14c6a1667f9420..9904627d513e0139de8512677015759d73d62305 100644 (file)
--- a/include/workspace.h
+++ b/include/workspace.h
@@ -16,7 +16,12 @@
 #ifndef _WORKSPACE_H
 #define _WORKSPACE_H
 
-
+/**
+ * Returns a pointer to the workspace with the given number (starting at 0),
+ * creating the workspace if necessary (by allocating the necessary amount of
+ * memory and initializing the data structures correctly).
+ *
+ */
 Workspace *workspace_get(int number);
 
 /**

diff --git a/src/workspace.c b/src/workspace.c
index c4f1ead199028dc961c9ca3c157d83c36f4dafee..b88e213bbbb664acbb7da46a2d646acbccc2d20c 100644 (file)
--- a/src/workspace.c
+++ b/src/workspace.c
@@ -27,6 +27,12 @@
 #include "workspace.h"
 #include "client.h"
 
+/*
+ * Returns a pointer to the workspace with the given number (starting at 0),
+ * creating the workspace if necessary (by allocating the necessary amount of
+ * memory and initializing the data structures correctly).
+ *
+ */
 Workspace *workspace_get(int number) {
         if (number > (num_workspaces-1)) {
                 int old_num_workspaces = num_workspaces;