diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2017-09-17 08:33:04 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-17 08:33:04 +0700 |
| commit | d30682ad2ef4acb011b16a64aa5c0c56918596ec (patch) | |
| tree | bbb393c780b6799c7ce62bb97d7a01451e3da4b6 | |
| parent | 5ccaf36c6bbbeffc5b3ffff14205af2f8e9a6848 (diff) | |
| parent | cbe7e9e309edc401a675fce79a9619ccec5b79de (diff) | |
Merge pull request #11312 from deliciousfudge/acceptdialog-docs
Rewrite the documentation of AcceptDialog class
| -rw-r--r-- | doc/classes/AcceptDialog.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 8821a450e5..4244e66a35 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -21,8 +21,8 @@ <argument index="2" name="action" type="String" default=""""> </argument> <description> - Add custom button to the dialog and return the created button. - The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed. + Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [custom_action] signal when pressed. + If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. </description> </method> <method name="add_cancel"> @@ -31,7 +31,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add custom cancel button to the dialog and return the created button. + Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button. </description> </method> <method name="get_hide_on_ok" qualifiers="const"> @@ -68,7 +68,7 @@ <argument index="0" name="line_edit" type="Node"> </argument> <description> - Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. + Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> <method name="set_hide_on_ok"> @@ -99,14 +99,14 @@ <signals> <signal name="confirmed"> <description> - Emitted when accepted. + Emitted when the dialog is accepted. </description> </signal> <signal name="custom_action"> <argument index="0" name="action" type="String"> </argument> <description> - Emitted with a custom button is added. + Emitted when a custom button is pressed. See [method add_button]. </description> </signal> </signals> |