[geeklog-cvs] geeklog: Updated comments note for COM_truncateHTML function

[geeklog-cvs at lists.geeklog.net]

changeset 7813:859fad6a5f34
url:  http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/rev/859fad6a5f34
user: Tom <websitemaster at cogeco.net>
date: Sat Mar 20 12:36:31 2010 -0400
description:
Updated comments note for COM_truncateHTML function

diffstat:

 public_html/lib-common.php |  7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diffs (17 lines):

diff -r ffc334a4da99 -r 859fad6a5f34 public_html/lib-common.php
--- a/public_html/lib-common.php	Thu Mar 18 14:32:11 2010 -0400
+++ b/public_html/lib-common.php	Sat Mar 20 12:36:31 2010 -0400
@@ -6602,9 +6602,10 @@
 * This function is multi-byte string aware. This function is based on a 
 * code snippet by pitje at Snipplr.com.
 *
-* NOTE: The truncated string may be shorter but will never be longer than
-*       $maxlen characters, i.e. the $filler string is taken into account.
-*       Characters from HTML tags are also taken into account. 
+* NOTE: The truncated string may be shorter or longer than $maxlen characters.
+* Currently any initial html tags in the truncated string are taken into account.
+* The $filler string is also taken into account but any html tags that are added 
+* by this function to close open html tags are not. 
 *
 * @param    string  $htmltext   the text string which contains HTML tags to truncate
 * @param    int     $maxlen     max. number of characters in the truncated string