Browse Source

Merge pull request #86839 from Mickeon/java-class-documentation

Add documentation to JavaClass & JavaClassWrapper
Rémi Verschelde 1 year ago
parent
commit
84a372d155
2 changed files with 9 additions and 0 deletions
  1. 4 0
      doc/classes/JavaClass.xml
  2. 5 0
      doc/classes/JavaClassWrapper.xml

+ 4 - 0
doc/classes/JavaClass.xml

@@ -1,8 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?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">
 <class name="JavaClass" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 	<brief_description>
 	<brief_description>
+		Represents an object from the Java Native Interface.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>

+ 5 - 0
doc/classes/JavaClassWrapper.xml

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?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">
 <class name="JavaClassWrapper" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 	<brief_description>
 	<brief_description>
+		Provides access to the Java Native Interface.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>
@@ -11,6 +14,8 @@
 			<return type="JavaClass" />
 			<return type="JavaClass" />
 			<param index="0" name="name" type="String" />
 			<param index="0" name="name" type="String" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>