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/gdnative/doc_classes/GDNative.xml | 18 ++++++---------- modules/gdnative/doc_classes/GDNativeLibrary.xml | 6 ++---- modules/gdnative/doc_classes/NativeScript.xml | 24 ++++++++-------------- modules/gdnative/doc_classes/PluginScript.xml | 3 +-- .../gdnative/doc_classes/VideoStreamGDNative.xml | 9 +++----- 5 files changed, 20 insertions(+), 40 deletions(-) (limited to 'modules/gdnative/doc_classes') diff --git a/modules/gdnative/doc_classes/GDNative.xml b/modules/gdnative/doc_classes/GDNative.xml index 4f1530598c..e4c5d34a2c 100644 --- a/modules/gdnative/doc_classes/GDNative.xml +++ b/modules/gdnative/doc_classes/GDNative.xml @@ -8,26 +8,20 @@ - - - - - - - - + + + + - - + - - + diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index 05cda05f9f..f84d4e60f3 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -12,15 +12,13 @@ - - + Returns paths to all dependency libraries for the current platform and architecture. - - + Returns the path to the dynamic library file for the current platform and architecture. diff --git a/modules/gdnative/doc_classes/NativeScript.xml b/modules/gdnative/doc_classes/NativeScript.xml index f2e9cac6dc..397d12a3a9 100644 --- a/modules/gdnative/doc_classes/NativeScript.xml +++ b/modules/gdnative/doc_classes/NativeScript.xml @@ -8,42 +8,34 @@ - - + Returns the documentation string that was previously set with [code]godot_nativescript_set_class_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code]. - - + Constructs a new object of the base type with a script of this type already attached. [i]Note[/i]: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. diff --git a/modules/gdnative/doc_classes/PluginScript.xml b/modules/gdnative/doc_classes/PluginScript.xml index 9616101090..8e28187482 100644 --- a/modules/gdnative/doc_classes/PluginScript.xml +++ b/modules/gdnative/doc_classes/PluginScript.xml @@ -8,8 +8,7 @@ - - + Returns a new instance of the script. diff --git a/modules/gdnative/doc_classes/VideoStreamGDNative.xml b/modules/gdnative/doc_classes/VideoStreamGDNative.xml index 153988bad8..8b1a3210df 100644 --- a/modules/gdnative/doc_classes/VideoStreamGDNative.xml +++ b/modules/gdnative/doc_classes/VideoStreamGDNative.xml @@ -11,17 +11,14 @@ - - + Returns the video file handled by this [VideoStreamGDNative]. - - - - + + Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats. -- cgit v1.2.3