summaryrefslogtreecommitdiffstats
path: root/doc/classes/JavaClassWrapper.xml
diff options
context:
space:
mode:
authorMicky <micheledevita2@gmail.com>2024-01-05 11:38:27 +0100
committerMicky <micheledevita2@gmail.com>2024-01-05 19:54:25 +0100
commit1310dd0730b5081e12d890fd509e869b4bff3369 (patch)
tree04eadde8d455f0e2cc0638e14d994e2f32bb4110 /doc/classes/JavaClassWrapper.xml
parent179dfdc8d78b5bd5377dd115af026df58308bdaf (diff)
downloadredot-engine-1310dd0730b5081e12d890fd509e869b4bff3369.tar.gz
Add documentation to JavaClass & JavaClassWrapper
Diffstat (limited to 'doc/classes/JavaClassWrapper.xml')
-rw-r--r--doc/classes/JavaClassWrapper.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml
index e197b1e97e..01c3392b04 100644
--- a/doc/classes/JavaClassWrapper.xml
+++ b/doc/classes/JavaClassWrapper.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="JavaClassWrapper" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
+ Provides access to the Java Native Interface.
</brief_description>
<description>
+ 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.
</description>
<tutorials>
</tutorials>
@@ -11,6 +14,8 @@
<return type="JavaClass" />
<param index="0" name="name" type="String" />
<description>
+ 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].
</description>
</method>
</methods>