Documented function

qa-include/util/string.php

@@ -485,11 +485,17 @@
 	}
 
 
+	/**
+	 * Converts a string to a single line and removes words from it until it fits in the given length. Words are removed
+	 * from a position around two thirds of the string and are replaced by the given ellipsis string
+	 *
+	 * @param string $string Text that will be turned into a single line and cut, if necessary
+	 * @param int $length Maximum allowed length of the returned string. This value can be overriden by the length of the
+	 * ellipsis if it is higher than the maximum allowed length
+	 * @param string $ellipsis Text used to replace the removed words from the original text
+	 * @return string The string turned into a single line and cut to fit the given length
+	 */
 	function qa_shorten_string_line($string, $length)
-/*
-	Return no more than $length characters from $string after converting it to a single line, by
-	removing words from the middle (and especially towards the end)
-*/
 	{
 		if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }