diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2023-02-03 23:42:52 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-03 23:42:52 +0300 |
| commit | b0598dcdb7cd96e2614b687a57a64ce12245e19e (patch) | |
| tree | 00e63297d51733ab388eae77f5c4c73cb7285c85 /doc/classes | |
| parent | e14cacb8da9ca00bc81a614b63df625855989bbb (diff) | |
| parent | 03ae8caea8efa83eb272be90d00dbebea3fe4f89 (diff) | |
Merge pull request #72670 from YuriSizov/docs-signal-get-connections
Fix incorrect description for `Signal::get_connections`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Object.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Signal.xml | 5 |
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index e30ff6be19..ab7ae82875 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -639,7 +639,7 @@ <description> Returns an [Array] of connections for the given [param signal] name. Each connection is represented as a [Dictionary] that contains three entries: - [code]signal[/code] is a reference to the [Signal]; - - [code]callable[/code] is a reference to the [Callable]; + - [code]callable[/code] is a reference to the connected [Callable]; - [code]flags[/code] is a combination of [enum ConnectFlags]. </description> </method> diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 71905e8b2e..cdbeba0220 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -85,7 +85,10 @@ <method name="get_connections" qualifiers="const"> <return type="Array" /> <description> - Returns the list of [Callable]s connected to this signal. + Returns an [Array] of connections for this signal. Each connection is represented as a [Dictionary] that contains three entries: + - [code]signal[/code] is a reference to this signal; + - [code]callable[/code] is a reference to the connected [Callable]; + - [code]flags[/code] is a combination of [enum Object.ConnectFlags]. </description> </method> <method name="get_name" qualifiers="const"> |