Преглед изворни кода

Merge pull request #72670 from YuriSizov/docs-signal-get-connections

Fix incorrect description for `Signal::get_connections`
Yuri Sizov пре 2 година
родитељ
комит
b0598dcdb7
2 измењених фајлова са 5 додато и 2 уклоњено
  1. 1 1
      doc/classes/Object.xml
  2. 4 1
      doc/classes/Signal.xml

+ 1 - 1
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>

+ 4 - 1
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">