aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/config_php_file.php
diff options
context:
space:
mode:
authorTristan Darricau <github@nicofuma.fr>2014-06-29 18:39:19 +0200
committerTristan Darricau <github@nicofuma.fr>2014-07-07 01:02:37 +0200
commit15c23e60b8e4b78c68286ae76e03a12b81393159 (patch)
tree739649080a82c735385b3dcda143adb8d6270b65 /phpBB/phpbb/config_php_file.php
parentf2e8e928c08809202b1abf5668a46e3d9e735c38 (diff)
downloadforums-15c23e60b8e4b78c68286ae76e03a12b81393159.tar
forums-15c23e60b8e4b78c68286ae76e03a12b81393159.tar.gz
forums-15c23e60b8e4b78c68286ae76e03a12b81393159.tar.bz2
forums-15c23e60b8e4b78c68286ae76e03a12b81393159.tar.xz
forums-15c23e60b8e4b78c68286ae76e03a12b81393159.zip
[ticket/12775] Update doc blocks
PHPBB3-12775
Diffstat (limited to 'phpBB/phpbb/config_php_file.php')
-rw-r--r--phpBB/phpbb/config_php_file.php8
1 files changed, 4 insertions, 4 deletions
diff --git a/phpBB/phpbb/config_php_file.php b/phpBB/phpbb/config_php_file.php
index 5a2fbca0dd..ba8d3a0d9d 100644
--- a/phpBB/phpbb/config_php_file.php
+++ b/phpBB/phpbb/config_php_file.php
@@ -22,7 +22,7 @@ class config_php_file
protected $php_ext;
/**
- * Indicates if the php config file has been loaded.
+ * Indicates whether the php config file has been loaded.
*
* @var bool
*/
@@ -36,7 +36,7 @@ class config_php_file
protected $config_data = array();
/**
- * The path to the config file. (Defaults: $phpbb_root_path . 'config.' . $php_ext)
+ * The path to the config file. (Default: $phpbb_root_path . 'config.' . $php_ext)
*
* @var string
*/
@@ -45,7 +45,7 @@ class config_php_file
/**
* Constructor
*
- * @param string $phpbb_root_path Path to the phpbb includes directory.
+ * @param string $phpbb_root_path phpBB Root Path
* @param string $php_ext php file extension
*/
function __construct($phpbb_root_path, $php_ext)
@@ -67,7 +67,7 @@ class config_php_file
}
/**
- * Returns an array containing all the variables defined into the config.php file
+ * Returns an associative array containing the variables defined by the config file.
*
* @return bool|array Return the content of the config file or false if the file does not exists.
*/