From 1ddc9ea337a9ab4e9df361f3cb88a4673a6043a1 Mon Sep 17 00:00:00 2001
From: Uwe Steinmann <steinm@debian.org>
Date: Mon, 17 Nov 2014 11:27:19 +0100
Subject: [PATCH] better documentation for getFolderPathPlain()

---
 SeedDMS_Core/Core/inc.ClassFolder.php | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/SeedDMS_Core/Core/inc.ClassFolder.php b/SeedDMS_Core/Core/inc.ClassFolder.php
index d69eeb697..76190ee71 100644
--- a/SeedDMS_Core/Core/inc.ClassFolder.php
+++ b/SeedDMS_Core/Core/inc.ClassFolder.php
@@ -486,9 +486,13 @@ class SeedDMS_Core_Folder extends SeedDMS_Core_Object {
 	} /* }}} */
 
 	/**
-	 * Returns a unix file system path
+	 * Returns a file system path
 	 *
-	 * @return string path separated with '/'
+	 * This path contains spaces around the slashes for better readability.
+	 * Run str_replace(' / ', '/', $path) on it to get a valid unix
+	 * file system path.
+	 *
+	 * @return string path separated with ' / '
 	 */
 	function getFolderPathPlain() { /* {{{ */
 		$path="";