diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-04-08 11:19:11 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-04-08 11:19:11 +0200 |
| commit | 84a372d15561329c332f23dfcb9ee46c829bda29 (patch) | |
| tree | bc92fbd8bc29046f0fbcbb6ce13c3f07f14a11cf /doc | |
| parent | 3d5457533078eff3c7c922d7387b5e4ada8c5234 (diff) | |
| parent | 1310dd0730b5081e12d890fd509e869b4bff3369 (diff) | |
| download | redot-engine-84a372d15561329c332f23dfcb9ee46c829bda29.tar.gz | |
Merge pull request #86839 from Mickeon/java-class-documentation
Add documentation to JavaClass & JavaClassWrapper
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/JavaClass.xml | 4 | ||||
| -rw-r--r-- | doc/classes/JavaClassWrapper.xml | 5 |
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/classes/JavaClass.xml b/doc/classes/JavaClass.xml index 541f23013d..ecfcaa8781 100644 --- a/doc/classes/JavaClass.xml +++ b/doc/classes/JavaClass.xml @@ -1,8 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="JavaClass" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Represents an object from the Java Native Interface. </brief_description> <description> + 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]. </description> <tutorials> </tutorials> 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> |