From b150ceb62cfd91f11b62f823f3dd5517a640cbc3 Mon Sep 17 00:00:00 2001 From: Kelly Thomas Date: Sun, 7 Oct 2018 21:52:07 +0800 Subject: Update class documentation xml --- doc/classes/BaseButton.xml | 2 ++ doc/classes/CheckBox.xml | 4 +++ doc/classes/CheckButton.xml | 4 +++ doc/classes/ProjectSettings.xml | 18 ++++++++----- doc/classes/RichTextLabel.xml | 18 +++++++++---- doc/classes/ScriptCreateDialog.xml | 2 ++ doc/classes/SpinBox.xml | 2 ++ doc/classes/StreamPeerSSL.xml | 2 ++ doc/classes/TreeItem.xml | 7 ++--- doc/classes/VisualServer.xml | 2 +- modules/mono/doc_classes/GodotSharp.xml | 34 +++++++++++++++++++++--- modules/opensimplex/doc_classes/NoiseTexture.xml | 18 ------------- 12 files changed, 74 insertions(+), 39 deletions(-) diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 3ff8634010..3364770280 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -106,6 +106,8 @@ The state of buttons are disabled. + + Require just a press to consider the button clicked. diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index fb2cf64d98..a2a7cf85e8 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -31,10 +31,14 @@ + + + + diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index deba9a17b6..24875017fe 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -29,10 +29,14 @@ + + + + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 0b7c0a63ad..4516fc522a 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -102,7 +102,7 @@ - Returns true if the specified property exists and its initial value differs from the current value. + Returns true if the specified property exists and its initial value differs from the current value. @@ -111,14 +111,14 @@ - Returns the initial value of the specified property. Returns null if the property does not exist. + Returns the initial value of the specified property. Returns null if the property does not exist. - Saves the configuration to the project.godot file. + Saves the configuration to the project.godot file. @@ -127,7 +127,7 @@ - Saves the configuration to a custom file. + Saves the configuration to a custom file. @@ -213,8 +213,6 @@ Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. - - Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. @@ -697,6 +695,14 @@ + + + + + + + + Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 618f2f42b2..357d2e7a15 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -166,6 +166,12 @@ Adds a meta tag to the tag stack. Similar to the bbcode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. + + + + + + @@ -304,15 +310,17 @@ - + + + - + - + - + - + diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index 3de068dbcb..67ce9a8e87 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -24,6 +24,8 @@ + + Prefills required fields to configure the ScriptCreateDialog for use. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 0fcd5bbaf5..5087cf355a 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -19,6 +19,8 @@ + + diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index cf8769d22b..33948df509 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -63,6 +63,8 @@ A status representing a [code]StreamPeerSSL[/code] that is disconnected. + + A status representing a [code]StreamPeerSSL[/code] that is connected to a host. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index c5a63b1acb..a7c5c3f28c 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -559,13 +559,10 @@ Cell contains a range. - - Cell contains a range expression. - - + Cell contains an icon. - + Align text to the left. See [code]set_text_align()[/code]. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 58b3d33cdb..225a1f2bba 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -4380,7 +4380,7 @@ - + diff --git a/modules/mono/doc_classes/GodotSharp.xml b/modules/mono/doc_classes/GodotSharp.xml index 985c66464b..921c1ca825 100644 --- a/modules/mono/doc_classes/GodotSharp.xml +++ b/modules/mono/doc_classes/GodotSharp.xml @@ -23,18 +23,44 @@ Detaches the current thread from the mono runtime. - + + + + + + + + + + + + + + + + + + + Returns whether the domain is being finalized. + + + + + + + + + - Returns whether the scripts domain is loaded. - + - Returns whether the scripts domain is being finalized. + Returns whether the scripts domain is loaded. diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index 9642865c43..d88abb3180 100644 --- a/modules/opensimplex/doc_classes/NoiseTexture.xml +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -12,24 +12,6 @@ - - - - - - - Set texture height. - - - - - - - - - Set texture width. - - -- cgit v1.2.3