summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-07-08 08:12:04 +0200
committerGitHub <noreply@github.com>2019-07-08 08:12:04 +0200
commit6d4850b8b8debaee9a138b8e8c9120f00ffb8ad1 (patch)
treec9c12cdb22e93121af5f28cbefd185f9710cd68a
parent5869f9c735610e2ca1f17dc8821fcb2e80e0ac78 (diff)
parentcebb38e0b3e8dacd2fc4940abe75385d984345bf (diff)
Merge pull request #30412 from Larpon/docs/string-hex_to_int-improve
Improve hex_to_int documentation
-rw-r--r--doc/classes/EditorSettings.xml2
-rw-r--r--doc/classes/String.xml5
-rw-r--r--doc/classes/Viewport.xml16
3 files changed, 5 insertions, 18 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml
index 83e3729391..5395a8fcb0 100644
--- a/doc/classes/EditorSettings.xml
+++ b/doc/classes/EditorSettings.xml
@@ -182,7 +182,7 @@
</signals>
<constants>
<constant name="NOTIFICATION_EDITOR_SETTINGS_CHANGED" value="10000">
- Emitted when editor settings change. It used by various editor plugins to update their visuals on theme changes or logic on configuration changes.
+ Emitted when editor settings change. It used by various editor plugins to update their visuals on theme changes or logic on configuration changes.
</constant>
</constants>
</class>
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index 15d796be54..e513a44b1d 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -385,7 +385,10 @@
<return type="int">
</return>
<description>
- Converts a string containing a hexadecimal number into an integer.
+ Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "[code]0x[/code]" otherwise [code]0[/code] is returned.
+ [codeblock]
+ print("0xff".hex_to_int()) # Print "255"
+ [/codeblock]
</description>
</method>
<method name="http_escape">
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml
index 772d20a92e..5d5a62456f 100644
--- a/doc/classes/Viewport.xml
+++ b/doc/classes/Viewport.xml
@@ -141,13 +141,6 @@
Returns [code]true[/code] if the size override is enabled. See [method set_size_override].
</description>
</method>
- <method name="is_size_override_stretch_enabled" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch].
- </description>
- </method>
<method name="set_attach_to_screen_rect">
<return type="void">
</return>
@@ -175,15 +168,6 @@
Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size.
</description>
</method>
- <method name="set_size_override_stretch">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- If [code]true[/code], the size override affects stretch as well.
- </description>
- </method>
<method name="unhandled_input">
<return type="void">
</return>