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/config.rst | |
parent | 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 (diff) |
[ci skip] Add return types to library docs
Diffstat (limited to 'user_guide_src/source/libraries/config.rst')
-rw-r--r-- | user_guide_src/source/libraries/config.rst | 49 |
1 files changed, 23 insertions, 26 deletions
diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst index 8663324f2..b31815799 100644 --- a/user_guide_src/source/libraries/config.rst +++ b/user_guide_src/source/libraries/config.rst @@ -184,47 +184,44 @@ Class Reference .. method:: item($item[, $index='']) - :param string $item: config item name - :param string $index: index name, if the item is an element in a config - item that is itself an array. - :returns: mixed - the config item or FALSE if it does not exist + :param string $item: Config item name + :param string $index: Index name + :returns: Config item value or NULL if not found + :rtype: mixed Fetch a config file item. - .. method:: set_item($item, $value) - :param string $item: config item name - :param string $value: config item value - :returns: void + :param string $item: Config item name + :param string $value: Config item value + :rtype: void Sets a config file item to the specified value. - .. method:: slash_item($item) - :param string $item: config item name - :returns: moxied - the config item (slashed) or FALSE if it does not exist + :param string $item: config item name + :returns: Config item value with a trailing forward slash or NULL if not found + :rtype: mixed - This method is identical to :meth:item:, except it appends a forward + This method is identical to ``item()``, except it appends a forward slash to the end of the item, if it exists. - .. method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]]) - :param string $file: Configuration file name - :param bool $use_sections: Whether config values shoud be loaded into - their own section (index of the main config array) - :param bool $fail_gracefully: Whether to return FALSE or to display an - error message - :returns: bool + :param string $file: Configuration file name + :param bool $use_sections: Whether config values shoud be loaded into their own section (index of the main config array) + :param bool $fail_gracefully: Whether to return FALSE or to display an error message + :returns: TRUE on success, FALSE on failure + :rtype: bool Loads a configuration file. - .. method:: site_url() - :returns: string + :returns: Site URL + :rtype: string This method retrieves the URL to your site, along with the "index" value you've specified in the config file. @@ -232,10 +229,10 @@ Class Reference This method is normally accessed via the corresponding functions in the :doc:`URL Helper </helpers/url_helper>`. - .. method:: base_url() - :returns: string + :returns: Base URL + :rtype: string This method retrieves the URL to your site, plus an optional path such as to a stylesheet or image. @@ -243,9 +240,9 @@ Class Reference This method is normally accessed via the corresponding functions in the :doc:`URL Helper </helpers/url_helper>`. - .. method:: system_url() - :returns: string + :returns: URL pointing at your CI system/ directory + :rtype: string - This method retrieves the URL to your system folder. + This method retrieves the URL to your CodeIgniter system/ directory.
\ No newline at end of file |