From adb6734b491091663d9159efe6e5a5fa9ff5202f Mon Sep 17 00:00:00 2001 From: Rémi Verschelde Date: Sun, 19 Jan 2020 23:19:21 +0100 Subject: doc: Sync classref with current source --- doc/classes/@GlobalScope.xml | 5 +++++ doc/classes/JavaClass.xml | 13 +++++++++++++ doc/classes/JavaClassWrapper.xml | 21 +++++++++++++++++++++ doc/classes/PacketPeer.xml | 4 ++++ 4 files changed, 43 insertions(+) create mode 100644 doc/classes/JavaClass.xml create mode 100644 doc/classes/JavaClassWrapper.xml (limited to 'doc') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index e84e265983..a131f1f8c8 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -42,8 +42,13 @@ The [JSON] singleton. + + The [JavaClassWrapper] singleton. + [b]Note:[/b] Only implemented on Android. + The [JavaScript] singleton. + [b]Note:[/b] Only implemented on HTML5. The [Marshalls] singleton. diff --git a/doc/classes/JavaClass.xml b/doc/classes/JavaClass.xml new file mode 100644 index 0000000000..c56f3cd481 --- /dev/null +++ b/doc/classes/JavaClass.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml new file mode 100644 index 0000000000..f027ddb975 --- /dev/null +++ b/doc/classes/JavaClassWrapper.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index d52bf4e3bb..e8c1980dd9 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -67,6 +67,10 @@ If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. + + Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations. + The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY]. + -- cgit v1.2.3