diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
| commit | 28c2c975b118016d07212ed8e7c22ff280309f82 (patch) | |
| tree | f1552392a3d87efebd7c565c6414ae41dc208ee9 /user_guide_src/source/libraries/language.rst | |
| parent | 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 (diff) | |
[ci skip] Add return types to library docs
Diffstat (limited to 'user_guide_src/source/libraries/language.rst')
| -rw-r--r-- | user_guide_src/source/libraries/language.rst | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst index 10449b935..3014d8f09 100644 --- a/user_guide_src/source/libraries/language.rst +++ b/user_guide_src/source/libraries/language.rst @@ -110,20 +110,22 @@ Class Reference .. method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]]) - :param string $langfile: Language file to load - :param string $idiom: Language name (i.e. 'english') - :param bool $return: Whether to return the loaded array of translations - :param bool $add_suffix: Whether to add the '_lang' suffix to the language file name - :param string $alt_path: An alternative path to look in for the language file - :returns: void or array if the third parameter is set to TRUE + :param string $langfile: Language file to load + :param string $idiom: Language name (i.e. 'english') + :param bool $return: Whether to return the loaded array of translations + :param bool $add_suffix: Whether to add the '_lang' suffix to the language file name + :param string $alt_path: An alternative path to look in for the language file + :returns: Array of language lines if $return is set to TRUE, otherwise void + :rtype: mixed Loads a language file. .. method:: line($line[, $log_errors = TRUE]) - :param string $line: Language line key name - :param bool $log_errors: Whether to log an error if the line isn't found - :returns: string or FALSE on failure + :param string $line: Language line key name + :param bool $log_errors: Whether to log an error if the line isn't found + :returns: Language line string or FALSE on failure + :rtype: string Fetches a single translation line from the already loaded language files, based on the line's name.
\ No newline at end of file |