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/language_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/language_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/language_helper.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst index 9e5d9bdc9..e4d093725 100644 --- a/user_guide_src/source/helpers/language_helper.rst +++ b/user_guide_src/source/helpers/language_helper.rst @@ -27,16 +27,17 @@ The following functions are available: .. function:: lang($line[, $for = ''[, $attributes = array()]]) - :param string $line: Language line key - :param string $for: HTML "for" attribute (ID of the element we're creating a label for) - :param array $attributes: Any additional HTML attributes - :returns: string + :param string $line: Language line key + :param string $for: HTML "for" attribute (ID of the element we're creating a label for) + :param array $attributes: Any additional HTML attributes + :returns: HTML-formatted language line label + :rtype: string - This function returns a line of text from a loaded language file with - simplified syntax that may be more desirable for view files than - ``CI_Lang::line()``. + This function returns a line of text from a loaded language file with + simplified syntax that may be more desirable for view files than + ``CI_Lang::line()``. - Example:: + Example:: - echo lang('language_key', 'form_item_id', array('class' => 'myClass'); - // Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file + echo lang('language_key', 'form_item_id', array('class' => 'myClass')); + // Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file |