Add a @fixme comment on FormatJson::encode(); the '$isHtml' parameter's purpose and...

diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php
index 57ab165..1265314 100644 (file)
--- 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
         */