noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

doc: Markup fixes for enums and constants

Browse Source
This commit is contained in:
Rémi Verschelde
2019-12-06 23:09:20 +01:00
parent c5c320412f
commit 4eff13d768
50 changed files with 167 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/Theme.xml
+34 -34
View File
@@ -26,7 +26,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the [Color] at [code]name[/code] if the Theme has [code]type[/code].
Clears the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_constant">
@@ -37,7 +37,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the constant at [code]name[/code] if the Theme has [code]type[/code].
Clears the constant at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_font">
@@ -48,7 +48,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the [Font] at [code]name[/code] if the Theme has [code]type[/code].
Clears the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_icon">
@@ -59,7 +59,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the icon at [code]name[/code] if the Theme has [code]type[/code].
Clears the icon at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_stylebox">
@@ -70,14 +70,14 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Clears [StyleBox] at [code]name[/code] if the Theme has [code]type[/code].
Clears [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="copy_default_theme">
<return type="void">
</return>
<description>
Sets the Theme's values to a copy of the default theme values.
Sets the theme's values to a copy of the default theme values.
</description>
</method>
<method name="copy_theme">
@@ -86,7 +86,7 @@
<argument index="0" name="other" type="Theme">
</argument>
<description>
Sets the Theme's values to a copy of a given theme.
Sets the theme's values to a copy of a given theme.
</description>
</method>
<method name="get_color" qualifiers="const">
@@ -97,7 +97,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the [Color] at [code]name[/code] if the Theme has [code]type[/code].
Returns the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_color_list" qualifiers="const">
@@ -106,7 +106,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the Theme has [code]type[/code].
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].
</description>
</method>
<method name="get_constant" qualifiers="const">
@@ -117,7 +117,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the constant at [code]name[/code] if the Theme has [code]type[/code].
Returns the constant at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_constant_list" qualifiers="const">
@@ -126,7 +126,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the Theme has [code]type[/code].
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].
</description>
</method>
<method name="get_font" qualifiers="const">
@@ -137,7 +137,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the [Font] at [code]name[/code] if the Theme has [code]type[/code].
Returns the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_font_list" qualifiers="const">
@@ -146,7 +146,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the Theme has [code]type[/code].
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].
</description>
</method>
<method name="get_icon" qualifiers="const">
@@ -157,7 +157,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the icon [Texture] at [code]name[/code] if the Theme has [code]type[/code].
Returns the icon [Texture] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_icon_list" qualifiers="const">
@@ -166,7 +166,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the Theme has [code]type[/code].
Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox" qualifiers="const">
@@ -177,7 +177,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the icon [StyleBox] at [code]name[/code] if the Theme has [code]type[/code].
Returns the icon [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_list" qualifiers="const">
@@ -186,14 +186,14 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the Theme has [code]type[/code].
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_types" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the Theme has [code]type[/code].
Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].
</description>
</method>
<method name="get_type_list" qualifiers="const">
@@ -202,7 +202,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if the Theme has [code]type[/code].
Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].
</description>
</method>
<method name="has_color" qualifiers="const">
@@ -214,7 +214,7 @@
</argument>
<description>
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_constant" qualifiers="const">
@@ -226,7 +226,7 @@
</argument>
<description>
Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_font" qualifiers="const">
@@ -238,7 +238,7 @@
</argument>
<description>
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_icon" qualifiers="const">
@@ -250,7 +250,7 @@
</argument>
<description>
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_stylebox" qualifiers="const">
@@ -262,7 +262,7 @@
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_color">
@@ -275,8 +275,8 @@
<argument index="2" name="color" type="Color">
</argument>
<description>
Sets the Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code].
Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_constant">
@@ -289,8 +289,8 @@
<argument index="2" name="constant" type="int">
</argument>
<description>
Sets the Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code].
Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_font">
@@ -303,8 +303,8 @@
<argument index="2" name="font" type="Font">
</argument>
<description>
Sets the Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code].
Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_icon">
@@ -317,8 +317,8 @@
<argument index="2" name="texture" type="Texture">
</argument>
<description>
Sets the Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code].
Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_stylebox">
@@ -331,8 +331,8 @@
<argument index="2" name="texture" type="StyleBox">
</argument>
<description>
Sets Theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code].
Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
</methods>