From bc02b15e0ca0536e09442aa55c55553f049e2dde Mon Sep 17 00:00:00 2001 From: Ryan Kaldari Date: Wed, 19 Oct 2011 00:53:39 +0000 Subject: [PATCH] more accurate documentation for addValue() method --- includes/api/ApiResult.php | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index b644354f72..3b912fd790 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -246,11 +246,12 @@ class ApiResult extends ApiBase { /** * Add value to the output data at the given path. - * Path is an indexed array, each element specifying the branch at which to add the new value - * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value - * If $name is empty, the $value is added as a next list element data[] = $value + * Path can be an indexed array, each element specifying the branch at which to add the new + * value. Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value. + * If $path is null, the value will be inserted at the data root. + * If $name is empty, the $value is added as a next list element data[] = $value. * - * @param $path + * @param $path array|string|null * @param $name string * @param $value mixed * @param $overwrite bool -- 2.20.1