[ci skip] Add return types to helper docs (+ some other formatting)

1 files changed, 42 insertions, 55 deletions

diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index 9e9d7ca62..3324da8c0 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -28,7 +28,8 @@ The following functions are available:
 .. function:: br([$count = 1])
 
 	:param	int	$count: Number of times to repeat the tag
-	:returns:	string
+	:returns:	HTML line break tag
+	:rtype:	string
 
 	Generates line break tags (<br />) based on the number you submit.
 	Example::
@@ -41,13 +42,13 @@ The following functions are available:
 
 		<br /><br /><br />
 
-
 .. function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
 
 	:param	string	$data: Content
 	:param	string	$h: Heading level
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML heading tag
+	:rtype:	string
 
 	Lets you create HTML heading tags. The first parameter will contain the
 	data, the second the size of the heading. Example::
@@ -67,13 +68,13 @@ The following functions are available:
 
 		<h3 class="pink">Welcome!<h3>
 
-
 .. function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
 
 	:param	string	$src: Image source data
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML image tag
+	:rtype:	string
 
 	Lets you create HTML <img /> tags. The first parameter contains the
 	image source. Example::
@@ -106,8 +107,7 @@ The following functions are available:
 		img($image_properties);
 		// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
 
-
-.. function:: ling_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
+.. function:: link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
 
 	:param	string	$href: What are we linking to
 	:param	string	$rel: Relation type
@@ -115,7 +115,8 @@ The following functions are available:
 	:param	string	$title: Link title
 	:param	string	$media: Media type
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
-	:returns:	string
+	:returns:	HTML link tag
+	:rtype:	string
 
 	Lets you create HTML <link /> tags. This is useful for stylesheet links,
 	as well as other links. The parameters are *href*, with optional *rel*,
@@ -150,11 +151,11 @@ The following functions are available:
 		echo link_tag($link);
 		// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
 
-
 .. function:: nbs([$num = 1])
 
 	:param	int	$num: Number of space entities to produce
-	:returns:	string
+	:returns:	A sequence of non-breaking space HTML entities
+	:rtype:	string
 
 	Generates non-breaking spaces (&nbsp;) based on the number you submit.
 	Example::
@@ -172,7 +173,8 @@ The following functions are available:
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML-formatted unordered list
+	:rtype:	string
 
 	Permits you to generate ordered or unordered HTML lists from simple or
 	multi-dimensional arrays. Example::
@@ -291,19 +293,20 @@ The following functions are available:
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML-formatted ordered list
+	:rtype:	string
 
 	Identical to :func:`ul()`, only it produces the <ol> tag for
 	ordered lists instead of <ul>.
 
-
 .. function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]])
 
 	:param	string	$name: Meta name
 	:param	string	$content: Meta content
 	:param	string	$type: Meta type
 	:param	string	$newline: Newline character
-	:returns:	string
+	:returns:	HTML meta tag
+	:rtype:	string
 
 	Helps you generate meta tags. You can pass strings to the function, or
 	simple arrays, or multidimensional ones.
@@ -355,6 +358,8 @@ The following functions are available:
 .. function:: doctype([$type = 'xhtml1-strict'])
 
 	:param	string	$type: Doctype name
+	:returns:	HTML DocType tag
+	:rtype:	string
 
 	Helps you generate document type declarations, or DTD's. XHTML 1.0
 	Strict is used by default, but many doctypes are available.
@@ -368,44 +373,26 @@ The following functions are available:
 	The following is a list of doctype choices. These are configurable, and
 	pulled from application/config/doctypes.php
 
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| Doctype                       | Option                       | Result                                                                                                                                           |
-	+===============================+==============================+==================================================================================================================================================+
-	| XHTML 1.1                     | doctype('xhtml11')           | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">                                                |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Strict              | doctype('xhtml1-strict')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Transitional        | doctype('xhtml1-trans')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">                        |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Frameset            | doctype('xhtml1-frame')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">                                |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML Basic 1.1               | doctype('xhtml-basic11')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">                                    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 5                        | doctype('html5')             | <!DOCTYPE html>                                                                                                                                  |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Strict                 | doctype('html4-strict')      | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">                                                       |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Transitional           | doctype('html4-trans')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">                                           |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Frameset               | doctype('html4-frame')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">                                            |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| MathML 1.01                   | doctype('mathml1')	       | <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">                                                                           |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| MathML 2.0                    | doctype('mathml2')           | <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">                                             |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.0                       | doctype('svg10')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">                                       |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Full                  | doctype('svg11')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">                                               |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Basic                 | doctype('svg11-basic')       | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">                                   |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Tiny                  | doctype('svg11-tiny')        | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">                                     |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+MathML+SVG (XHTML host) | doctype('xhtml-math-svg-xh') | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+MathML+SVG (SVG host)   | doctype('xhtml-math-svg-sh') | <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+RDFa 1.0                | doctype('xhtml-rdfa-1')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">                                          |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+RDFa 1.1                | doctype('xhtml-rdfa-2')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">                                          |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
\ No newline at end of file
+	=============================== =================== ==================================================================================================================================================
+	Document type                   Option              Result
+	=============================== =================== ==================================================================================================================================================
+	XHTML 1.1                       xhtml11             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+	XHTML 1.0 Strict                xhtml1-strict       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+	XHTML 1.0 Transitional          xhtml1-trans        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+	XHTML 1.0 Frameset              xhtml1-frame        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+	XHTML Basic 1.1                 xhtml-basic11       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+	HTML 5                          html5               <!DOCTYPE html>
+	HTML 4 Strict                   html4-strict        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+	HTML 4 Transitional             html4-trans         <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+	HTML 4 Frameset                 html4-frame         <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
+	MathML 1.01                     mathml1             <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">
+	MathML 2.0                      mathml2             <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">
+	SVG 1.0                         svg10               <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+	SVG 1.1 Full                    svg11               <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+	SVG 1.1 Basic                   svg11-basic         <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">
+	SVG 1.1 Tiny                    svg11-tiny          <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">
+	XHTML+MathML+SVG (XHTML host)   xhtml-math-svg-xh   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+	XHTML+MathML+SVG (SVG host)     xhtml-math-svg-sh   <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+	XHTML+RDFa 1.0                  xhtml-rdfa-1        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
+	XHTML+RDFa 1.1                  xhtml-rdfa-2        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">
+	=============================== =================== ==================================================================================================================================================
\ No newline at end of file