godot/doc/classes/JavaClassWrapper.xml

<?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>
	<methods>
		<method name="wrap">
			<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>
</class>
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="JavaClassWrapper" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`<brief_description>`
Add documentation to JavaClass & JavaClassWrapper 2024-01-05 18:38:27 +08:00			`Provides access to the Java Native Interface.`
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`</brief_description>`
			`<description>`
Add documentation to JavaClass & JavaClassWrapper 2024-01-05 18:38:27 +08:00			`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.`
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="wrap">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="JavaClass" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="name" type="String" />`
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`<description>`
Add documentation to JavaClass & JavaClassWrapper 2024-01-05 18:38:27 +08:00			`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].`
doc: Sync classref with current source 2020-01-20 06:19:21 +08:00			`</description>`
			`</method>`
			`</methods>`
			`</class>`