From: Michael Stapelberg <michael@stapelberg.de>
Date: Sun, 27 Sep 2009 13:20:47 +0000 (+0200)
Subject: Add documentation for workspace_get()
X-Git-Tag: 3.d~75
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=9b1699f4c4fdfcc06f9fca4e1216bfd7103d9b61;p=i3%2Fi3

Add documentation for workspace_get()
---

diff --git a/include/workspace.h b/include/workspace.h
index 6a17f597..9904627d 100644
--- 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 c4f1ead1..b88e213b 100644
--- 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;