summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/JSON.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml
index 2e837dea1d..a9fb50c262 100644
--- a/doc/classes/JSON.xml
+++ b/doc/classes/JSON.xml
@@ -30,6 +30,28 @@
<description>
Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network.
[b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types.
+ Use [code]indent[/code] parameter to pretty print the output.
+ [b]Example output:[/b]
+ [codeblock]
+ ## JSON.print(my_dictionary)
+ {"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]}
+
+ ## JSON.print(my_dictionary, "\t")
+ {
+ "name": "my_dictionary",
+ "version": "1.0.0",
+ "entities": [
+ {
+ "name": "entity_0",
+ "value": "value_0"
+ },
+ {
+ "name": "entity_1",
+ "value": "value_1"
+ }
+ ]
+ }
+ [/codeblock]
</description>
</method>
</methods>