diff options
author | Takamura <plehanov.v@gmail.com> | 2017-03-31 12:58:14 +1000 |
---|---|---|
committer | Andreas Gohr <andi@splitbrain.org> | 2017-03-31 09:33:33 +0200 |
commit | f50a239b3b819527445d240746b09a05fb76d103 (patch) | |
tree | 7a7094ce2741cca0e6ff47d68e2c69c8543aed5d /inc/confutils.php | |
parent | 3476bb81a3484baad8418870e1351c292b82291f (diff) | |
download | dokuwiki-f50a239b3b819527445d240746b09a05fb76d103.tar.gz dokuwiki-f50a239b3b819527445d240746b09a05fb76d103.zip |
I supplemented the existing comments on the methods in which there was not enough information to the standard phpDoc.
Diffstat (limited to 'inc/confutils.php')
-rw-r--r-- | inc/confutils.php | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/inc/confutils.php b/inc/confutils.php index e3d2bf994..47ee68969 100644 --- a/inc/confutils.php +++ b/inc/confutils.php @@ -202,6 +202,11 @@ function getSchemes() { * @author Harry Fuecks <hfuecks@gmail.com> * @author Andreas Gohr <andi@splitbrain.org> * @author Gina Haeussge <gina@foosel.net> + * + * @param array $lines + * @param bool $lower + * + * @return array */ function linesToHash($lines, $lower=false) { $conf = array(); @@ -235,6 +240,11 @@ function linesToHash($lines, $lower=false) { * @author Harry Fuecks <hfuecks@gmail.com> * @author Andreas Gohr <andi@splitbrain.org> * @author Gina Haeussge <gina@foosel.net> + * + * @param string $file + * @param bool $lower + * + * @return array */ function confToHash($file,$lower=false) { $conf = array(); @@ -249,15 +259,16 @@ function confToHash($file,$lower=false) { * * @author Chris Smith <chris@jalakai.co.uk> * - * @param string $type the configuration settings to be read, must correspond to a key/array in $config_cascade - * @param callback $fn the function used to process the configuration file into an array - * @param array $params optional additional params to pass to the callback - * @param callback $combine the function used to combine arrays of values read from different configuration files; + * @param string $type the configuration settings to be read, must correspond to a key/array in $config_cascade + * @param callback $fn the function used to process the configuration file into an array + * @param array $params optional additional params to pass to the callback + * @param callable|string $combine the function used to combine arrays of values read from different configuration files; * the function takes two parameters, * $combined - the already read & merged configuration values * $new - array of config values from the config cascade file being currently processed * and returns an array of the merged configuration values. - * @return array configuration values + * + * @return array configuration values */ function retrieveConfig($type,$fn,$params=null,$combine='array_merge') { global $config_cascade; |