From 0ce5e9257e71dd8bf21379c3cbe774be8e4efd7b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= <jfd@butonic.de>
Date: Mon, 12 Nov 2012 14:04:23 +0100
Subject: [PATCH] add php-doc for ellipsis

---
 lib/helper.php | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/lib/helper.php b/lib/helper.php
index 5a93e6533d..02e36d601d 100644
--- a/lib/helper.php
+++ b/lib/helper.php
@@ -712,8 +712,14 @@ class OC_Helper {
 
 		return false;
 	}
-	
 
+	/**
+	 * Shortens str to maxlen by replacing characters in the middle with '...', eg.
+	 * ellipsis('a very long string with lots of useless info to make a better example', 14) becomes 'a very ...example'
+	 * @param string $str the string
+	 * @param string $maxlen the maximum length of the result
+	 * @return string with at most maxlen characters
+	 */
 	public static function ellipsis($str, $maxlen) {
 		if (strlen($str) > $maxlen) {
 			$characters = floor($maxlen / 2);
@@ -721,5 +727,5 @@ class OC_Helper {
 		}
 		return $str;
 	}
-	
+
 }