docs: fix action, mouse extensions return values

Fixed documented return values for action and mouse input extensions to reflect that they are now void instead of returning Tasks.
chickensoft-games · Jan 22, 2024 · e5cd58d · e5cd58d
1 parent aca85b3
commit e5cd58d
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 10 deletions.
diff --git a/GodotTestDriver/Input/ActionsControlExtensions.cs b/GodotTestDriver/Input/ActionsControlExtensions.cs
@@ -36,9 +36,7 @@ string actionName
     /// </summary>
     /// <param name="node">Node to supply input to.</param>
     /// <param name="actionName">Name of the action.</param>
-    /// <param name="strength">Action strength (optional — default is 1.0).
-    /// </param>
-    /// <returns>Task that completes when the input finishes.</returns>
+    /// <param name="strength">Action strength (optional — default is 1.0).</param>
     public static void StartAction(
         this Node node, string actionName, float strength = 1f
     )
@@ -57,8 +55,6 @@ public static void StartAction(
     /// </summary>
     /// <param name="node">Node to supply input to.</param>
     /// <param name="actionName">Name of the action.</param>
-
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void EndAction(this Node node, string actionName)
     {
         Input.ParseInputEvent(new InputEventAction

diff --git a/GodotTestDriver/Input/MouseControlExtensions.cs b/GodotTestDriver/Input/MouseControlExtensions.cs
@@ -15,7 +15,6 @@ public static class MouseControlExtensions
     /// <param name="viewport">Viewport.</param>
     /// <param name="position">Position, in viewport coordinates.</param>
     /// <param name="button">Mouse button.</param>
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void ClickMouseAt(this Viewport viewport, Vector2 position, MouseButton button = MouseButton.Left)
     {
         viewport.PressMouseAt(position, button);
@@ -27,7 +26,6 @@ public static void ClickMouseAt(this Viewport viewport, Vector2 position, MouseB
     /// </summary>
     /// <param name="viewport">Viewport.</param>
     /// <param name="position">Position, in viewport coordinates.</param>
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void MoveMouseTo(this Viewport viewport, Vector2 position)
     {
         var oldPosition = viewport.GetMousePosition();
@@ -49,7 +47,6 @@ public static void MoveMouseTo(this Viewport viewport, Vector2 position)
     /// <param name="start">Start position, in viewport coordinates.</param>
     /// <param name="end">End position, in viewport coordinates.</param>
     /// <param name="button">Mouse button.</param>
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void DragMouse(this Viewport viewport, Vector2 start, Vector2 end, MouseButton button = MouseButton.Left)
     {
         viewport.PressMouseAt(start, button);
@@ -61,7 +58,6 @@ public static void DragMouse(this Viewport viewport, Vector2 start, Vector2 end,
     /// </summary>
     /// <param name="_">Viewport.</param>
     /// <param name="button">Mouse button (left by default).</param>
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void PressMouse(this Viewport _, MouseButton button = MouseButton.Left)
     {
         var action = new InputEventMouseButton
@@ -78,7 +74,6 @@ public static void PressMouse(this Viewport _, MouseButton button = MouseButton.
     /// </summary>
     /// <param name="_">Viewport.</param>
     /// <param name="button">Mouse button (left by default).</param>
-    /// <returns>Task that completes when the input finishes.</returns>
     public static void ReleaseMouse(this Viewport _, MouseButton button = MouseButton.Left)
     {
         var action = new InputEventMouseButton