From 3de130c2da3b93a3404f264e92d7b65354de3548 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Fri, 7 Feb 2014 23:31:49 +0200 Subject: [ci skip] Add return types to helper docs (+ some other formatting) --- user_guide_src/source/helpers/typography_helper.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'user_guide_src/source/helpers/typography_helper.rst') diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst index d32befac1..deb3d164e 100644 --- a/user_guide_src/source/helpers/typography_helper.rst +++ b/user_guide_src/source/helpers/typography_helper.rst @@ -29,7 +29,8 @@ The following functions are available: :param string $str: Input string :param bool $reduce_linebreaks: Whether to reduce multiple instances of double newlines to two - :returns: string + :returns: HTML-formatted typography-safe string + :rtype: string Formats text so that it is semantically and typographically correct HTML. @@ -51,7 +52,8 @@ The following functions are available: .. function:: nl2br_except_pre($str) :param string $str: Input string - :returns: string + :returns: String with HTML-formatted line breaks + :rtype: string Converts newlines to
tags unless they appear within 
 tags.
 	This function is identical to the native PHP ``nl2br()`` function,
@@ -61,12 +63,12 @@ The following functions are available:
 
 		$string = nl2br_except_pre($string);
 
-
 .. function:: entity_decode($str, $charset = NULL)
 
 	:param	string	$str: Input string
 	:param	string	$charset: Character set
-	:returns:	string
+	:returns:	String with decoded HTML entities
+	:rtype:	string
 
 	This function is an alias for ``CI_Security::entity_decode()``.
 	Fore more info, please see the :doc:`Security Library
-- 
cgit v1.2.3-24-g4f1b