瀏覽代碼

Merge pull request #34901 from YeldhamDev/multiple_doc_completions

Complete docs for GraphEdit/Node and PopupMenu
Rémi Verschelde 5 年之前
父節點
當前提交
1b26205b25
共有 3 個文件被更改,包括 29 次插入14 次删除
  1. 10 8
      doc/classes/GraphEdit.xml
  2. 17 6
      doc/classes/GraphNode.xml
  3. 2 0
      doc/classes/PopupMenu.xml

+ 10 - 8
doc/classes/GraphEdit.xml

@@ -160,6 +160,7 @@
 			<argument index="4" name="amount" type="float">
 			</argument>
 			<description>
+				Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property.
 			</description>
 		</method>
 		<method name="set_selected">
@@ -194,12 +195,12 @@
 	<signals>
 		<signal name="_begin_node_move">
 			<description>
-				Signal sent at the beginning of a GraphNode movement.
+				Emitted at the beginning of a GraphNode movement.
 			</description>
 		</signal>
 		<signal name="_end_node_move">
 			<description>
-				Signal sent at the end of a GraphNode movement.
+				Emitted at the end of a GraphNode movement.
 			</description>
 		</signal>
 		<signal name="connection_from_empty">
@@ -210,7 +211,7 @@
 			<argument index="2" name="release_position" type="Vector2">
 			</argument>
 			<description>
-				Signal sent when user dragging connection from input port into empty space of the graph.
+				Emitted when user dragging connection from input port into empty space of the graph.
 			</description>
 		</signal>
 		<signal name="connection_request">
@@ -223,7 +224,7 @@
 			<argument index="3" name="to_slot" type="int">
 			</argument>
 			<description>
-				Signal sent to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created.
+				Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created.
 			</description>
 		</signal>
 		<signal name="connection_to_empty">
@@ -234,17 +235,17 @@
 			<argument index="2" name="release_position" type="Vector2">
 			</argument>
 			<description>
-				Signal sent when user dragging connection from output port into empty space of the graph.
+				Emitted when user dragging connection from output port into empty space of the graph.
 			</description>
 		</signal>
 		<signal name="copy_nodes_request">
 			<description>
-				Signal sent when the user presses [code]Ctrl + C[/code].
+				Emitted when the user presses [code]Ctrl + C[/code].
 			</description>
 		</signal>
 		<signal name="delete_nodes_request">
 			<description>
-				Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
+				Emitted when a GraphNode is attempted to be removed from the GraphEdit.
 			</description>
 		</signal>
 		<signal name="disconnection_request">
@@ -274,7 +275,7 @@
 		</signal>
 		<signal name="paste_nodes_request">
 			<description>
-				Signal sent when the user presses [code]Ctrl + V[/code].
+				Emitted when the user presses [code]Ctrl + V[/code].
 			</description>
 		</signal>
 		<signal name="popup_request">
@@ -288,6 +289,7 @@
 			<argument index="0" name="ofs" type="Vector2">
 			</argument>
 			<description>
+				Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.
 			</description>
 		</signal>
 	</signals>

+ 17 - 6
doc/classes/GraphNode.xml

@@ -170,12 +170,12 @@
 			<argument index="8" name="custom_right" type="Texture" default="null">
 			</argument>
 			<description>
-				Sets properties of the slot with id [code]idx[/code].
+				Sets properties of the slot with ID [code]idx[/code].
 				If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side.
 				[code]type_left[/code]/[code]right[/code] is an arbitrary type of the port. Only ports with the same type values can be connected.
 				[code]color_left[/code]/[code]right[/code] is the tint of the port's icon on this side.
 				[code]custom_left[/code]/[code]right[/code] is a custom texture for this side's port.
-				[b]Note:[/b] this method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode.
+				[b]Note:[/b] This method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode.
 			</description>
 		</method>
 	</methods>
@@ -188,20 +188,27 @@
 			[b]Note:[/b] You cannot use position directly, as [GraphEdit] is a [Container].
 		</member>
 		<member name="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay" default="0">
+			Sets the overlay shown above the GraphNode. See [enum Overlay].
 		</member>
 		<member name="resizable" type="bool" setter="set_resizable" getter="is_resizable" default="false">
+			If [code]true[/code], the user can resize the GraphNode.
+			[b]Note:[/b] Dragging the handle will only trigger the [signal resize_request] signal, the GraphNode needs to be resized manually.
 		</member>
 		<member name="selected" type="bool" setter="set_selected" getter="is_selected" default="false">
+			If [code]true[/code], the GraphNode is selected.
 		</member>
 		<member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible" default="false">
+			If [code]true[/code], the close button will be visible.
+			[b]Note:[/b] Pressing it will only trigger the [signal close_request] signal, the GraphNode needs to be removed manually.
 		</member>
 		<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
+			The text displayed in the GraphNode's title bar.
 		</member>
 	</members>
 	<signals>
 		<signal name="close_request">
 			<description>
-				Signal sent on closing the GraphNode.
+				Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see [member show_close]).
 			</description>
 		</signal>
 		<signal name="dragged">
@@ -210,32 +217,36 @@
 			<argument index="1" name="to" type="Vector2">
 			</argument>
 			<description>
-				Signal sent when the GraphNode is dragged.
+				Emitted when the GraphNode is dragged.
 			</description>
 		</signal>
 		<signal name="offset_changed">
 			<description>
-				Signal sent when the GraphNode is moved.
+				Emitted when the GraphNode is moved.
 			</description>
 		</signal>
 		<signal name="raise_request">
 			<description>
-				Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
+				Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
 			</description>
 		</signal>
 		<signal name="resize_request">
 			<argument index="0" name="new_minsize" type="Vector2">
 			</argument>
 			<description>
+				Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]).
 			</description>
 		</signal>
 	</signals>
 	<constants>
 		<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">
+			No overlay is shown.
 		</constant>
 		<constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay">
+			Show overlay set in the [code]breakpoint[/code] theme property.
 		</constant>
 		<constant name="OVERLAY_POSITION" value="2" enum="Overlay">
+			Show overlay set in the [code]position[/code] theme property.
 		</constant>
 	</constants>
 	<theme_items>

+ 2 - 0
doc/classes/PopupMenu.xml

@@ -521,6 +521,7 @@
 			<argument index="1" name="state" type="int">
 			</argument>
 			<description>
+				Sets the state of an multistate item. See [method add_multistate_item] for details.
 			</description>
 		</method>
 		<method name="set_item_shortcut">
@@ -595,6 +596,7 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Cycle to the next state of an multistate item. See [method add_multistate_item] for details.
 			</description>
 		</method>
 	</methods>