diff options
| author | Yuri Sizov <yuris@humnom.net> | 2023-02-03 16:40:01 +0100 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-02-03 17:28:17 +0100 |
| commit | 03ae8caea8efa83eb272be90d00dbebea3fe4f89 (patch) | |
| tree | 1cd374673227158de2a0e744ddf62e28d74ab76d | |
| parent | 604493eb6ee3def65aca089c1d4bc71ea03ca19a (diff) | |
Fix incorrect description for `Signal::get_connections`
| -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"> |