From 1310dd0730b5081e12d890fd509e869b4bff3369 Mon Sep 17 00:00:00 2001 From: Micky Date: Fri, 5 Jan 2024 11:38:27 +0100 Subject: [PATCH] Add documentation to JavaClass & JavaClassWrapper --- doc/classes/JavaClass.xml | 4 ++++ doc/classes/JavaClassWrapper.xml | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/doc/classes/JavaClass.xml b/doc/classes/JavaClass.xml index 541f23013da..ecfcaa87815 100644 --- a/doc/classes/JavaClass.xml +++ b/doc/classes/JavaClass.xml @@ -1,8 +1,12 @@ + Represents an object from the Java Native Interface. + Represents an object from the Java Native Interface. It is returned from [method JavaClassWrapper.wrap]. + [b]Note:[/b] This class only works on Android. For any other build, this class does nothing. + [b]Note:[/b] This class is not to be confused with [JavaScriptObject]. diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml index e197b1e97e6..01c3392b049 100644 --- a/doc/classes/JavaClassWrapper.xml +++ b/doc/classes/JavaClassWrapper.xml @@ -1,8 +1,11 @@ + Provides access to the Java Native Interface. + The JavaClassWrapper singleton provides a way for the Godot application to send and receive data through the [url=https://developer.android.com/training/articles/perf-jni]Java Native Interface[/url] (JNI). + [b]Note:[/b] This singleton is only available in Android builds. @@ -11,6 +14,8 @@ + Wraps a class defined in Java, and returns it as a [JavaClass] [Object] type that Godot can interact with. + [b]Note:[/b] This method only works on Android. On every other platform, this method does nothing and returns an empty [JavaClass].