diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-07-30 16:42:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-30 16:42:52 +0200 |
| commit | 83ccf39adcefaa32325d607562f8f0889c215046 (patch) | |
| tree | 61ea8e8a202e2998e745de04516a9a2f34c9be1b /doc/classes/BaseButton.xml | |
| parent | a7363f3dfd32ecff77d4d6937be9f232bfc699c7 (diff) | |
| parent | 7adf4cc9b5de6701a41e27690a69b9892d5eed85 (diff) | |
Merge pull request #51067 from akien-mga/doc-return-argument-self-closing-tags
doc: Use self-closing tags for `return` and `argument`
Diffstat (limited to 'doc/classes/BaseButton.xml')
| -rw-r--r-- | doc/classes/BaseButton.xml | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index d842bac54a..889c703b07 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -10,40 +10,33 @@ </tutorials> <methods> <method name="_pressed" qualifiers="virtual"> - <return type="void"> - </return> + <return type="void" /> <description> Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead. </description> </method> <method name="_toggled" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="button_pressed" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="button_pressed" type="bool" /> <description> Called when the button is toggled (only if [member toggle_mode] is active). </description> </method> <method name="get_draw_mode" qualifiers="const"> - <return type="int" enum="BaseButton.DrawMode"> - </return> + <return type="int" enum="BaseButton.DrawMode" /> <description> Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the [enum DrawMode] enum. </description> </method> <method name="is_hovered" qualifiers="const"> - <return type="bool"> - </return> + <return type="bool" /> <description> Returns [code]true[/code] if the mouse has entered the button and has not left it yet. </description> </method> <method name="set_pressed_no_signal"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="pressed" type="bool" /> <description> Changes the [member pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group]. @@ -104,8 +97,7 @@ </description> </signal> <signal name="toggled"> - <argument index="0" name="button_pressed" type="bool"> - </argument> + <argument index="0" name="button_pressed" type="bool" /> <description> Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. </description> |