diff options
author | Craigory V Coppola <agentendercake@gmail.com> | 2018-04-17 10:18:57 -0400 |
---|---|---|
committer | RĂ©mi Verschelde <rverschelde@gmail.com> | 2018-04-19 21:09:53 +0200 |
commit | 0dd526e06273ee27696c9adf06aff4fb5384fb78 (patch) | |
tree | 4998bddc1a26e2e6f32166852fa6ef18632308a8 /doc/classes | |
parent | 8ae042a895a3527079a8b4fb6ef4e1a78a45a358 (diff) |
Docs update for several classes
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/Dictionary.xml | 1 | ||||
-rw-r--r-- | doc/classes/GraphEdit.xml | 1 | ||||
-rw-r--r-- | doc/classes/Object.xml | 1 | ||||
-rw-r--r-- | doc/classes/Script.xml | 1 | ||||
-rw-r--r-- | doc/classes/ScrollBar.xml | 1 | ||||
-rw-r--r-- | doc/classes/ScrollContainer.xml | 2 | ||||
-rw-r--r-- | doc/classes/SplitContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/TileMap.xml | 2 |
8 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 3c1413b028..9fa1e3ea6c 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -22,6 +22,7 @@ <argument index="0" name="deep" type="bool" default="False"> </argument> <description> + Creates a copy of the dictionary, and returns it. </description> </method> <method name="empty"> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 5fb12612ab..605efd9114 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -228,6 +228,7 @@ <argument index="0" name="node" type="Object"> </argument> <description> + Emitted when a GraphNode is selected. </description> </signal> <signal name="popup_request"> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index b5986ec0f5..0717836366 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -398,6 +398,7 @@ <signals> <signal name="script_changed"> <description> + Emitted whenever the script of the Object is changed. </description> </signal> </signals> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 4257991e0d..97f6a60f01 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -24,6 +24,7 @@ <return type="Script"> </return> <description> + Returns the script directly inherited by this script. </description> </method> <method name="get_instance_base_type" qualifiers="const"> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index d3e6c62e49..736b780218 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -19,6 +19,7 @@ <signals> <signal name="scrolling"> <description> + Emitted whenever the scrollbar is being scrolled. </description> </signal> </signals> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 28fbdea58d..64b0fcfd83 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -31,10 +31,12 @@ <signals> <signal name="scroll_ended"> <description> + Emitted whenever scrolling stops. </description> </signal> <signal name="scroll_started"> <description> + Emitted whenever scrolling is started. </description> </signal> </signals> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 692598f382..d56da68448 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -16,6 +16,7 @@ <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> </member> <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility"> + Determines whether the dragger is visible. </member> <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset"> </member> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 6ee9489995..ec67370c79 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -178,6 +178,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set any collision layer to be [code]true[/code] or [code]false[/code]. </description> </method> <method name="set_collision_mask_bit"> @@ -303,6 +304,7 @@ Tile origin at its center. </constant> <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2" enum="TileOrigin"> + Tile origin at its bottom-left corner. </constant> </constants> </class> |