diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
| commit | 3de130c2da3b93a3404f264e92d7b65354de3548 (patch) | |
| tree | 368b1847fffe7af21c5fbc3fa7925212b678e60b /user_guide_src/source/helpers/typography_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/typography_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/typography_helper.rst | 10 |
1 files changed, 6 insertions, 4 deletions
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 <br /> tags unless they appear within <pre> 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 |