From d10a408d5ffd797c1dcbd484bc3f2408627d5bae Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Sat, 5 Feb 2011 21:06:44 +0000 Subject: [PATCH] Add a @fixme comment on FormatJson::encode(); the '$isHtml' parameter's purpose and function is not documented, but it seems to map to a pretty-printing parameter on Services_JSON(). If that's its purpose, it should be renamed and documented. Since it's a bare boolean parameter with no clear purpose in calls when "true" or "false" is passed bare, it probably also wants a nice legible constant value or two. --- includes/json/FormatJson.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php index 57ab165718..126531419a 100644 --- a/includes/json/FormatJson.php +++ b/includes/json/FormatJson.php @@ -16,6 +16,11 @@ class FormatJson { * * @param $value Mixed: the value being encoded. Can be any type except a resource. * @param $isHtml Boolean + * + * @fixme "$isHtml" parameter's purpose is not documented. It appears to + * map to a parameter labeled "pretty-print output with indents and + * newlines" in Services_JSON::encode(), which has no string relation + * to HTML output. * * @return string */ -- 2.20.1