From 7adf4cc9b5de6701a41e27690a69b9892d5eed85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 30 Jul 2021 15:28:05 +0200 Subject: 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. --- modules/webxr/doc_classes/WebXRInterface.xml | 39 ++++++++++------------------ 1 file changed, 13 insertions(+), 26 deletions(-) (limited to 'modules/webxr') diff --git a/modules/webxr/doc_classes/WebXRInterface.xml b/modules/webxr/doc_classes/WebXRInterface.xml index 67b2b866f3..ff7c46bbae 100644 --- a/modules/webxr/doc_classes/WebXRInterface.xml +++ b/modules/webxr/doc_classes/WebXRInterface.xml @@ -95,10 +95,8 @@ - - - - + + Gets an [XRPositionalTracker] for the given [code]controller_id[/code]. In the context of WebXR, a "controller" can be an advanced VR controller like the Oculus Touch or Index controllers, or even a tap on the screen, a spoken voice command or a button press on the device itself. When a non-traditional controller is used, interpret the position and orientation of the [XRPositionalTracker] as a ray pointing at the object the user wishes to interact with. @@ -112,10 +110,8 @@ - - - - + + Checks if the given [code]session_mode[/code] is supported by the user's browser. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode]WebXR's XRSessionMode[/url], including: [code]"immersive-vr"[/code], [code]"immersive-ar"[/code], and [code]"inline"[/code]. @@ -170,24 +166,21 @@ - - + Emitted after one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has started its "primary action". Use [method get_controller] to get more information about the controller. @@ -200,8 +193,7 @@ - - + Emitted by [method XRInterface.initialize] if the session fails to start. [code]message[/code] may optionally contain an error message from WebXR, or an empty string if no message is available. @@ -214,33 +206,28 @@ - - - - + + Emitted by [method is_session_supported] to indicate if the given [code]session_mode[/code] is supported or not. - - + Emitted after one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has started its "primary squeeze action". Use [method get_controller] to get more information about the controller. -- cgit v1.2.3