Updates doc comment.

Maaack · Dec 23, 2023 · 06dda4d · 06dda4d
1 parent 050be3b
commit 06dda4d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/App/Scripts/InGameMenuController.gd b/App/Scripts/InGameMenuController.gd
@@ -1,9 +1,10 @@
 class_name InGameMenuController
 extends Node
-## Interface for managing an in-game menu that can safely pause the game.
+## Interface for managing a single in-game menu at a time.
 ##
-## This (static) class manages one menu at a time. The scene_tree property
-## must be set for the static methods to work.
+## This (static) class manages one in-game menu at a time.
+## It can optionally safely pause and unpause the game for the menu.
+## The scene_tree property must be set for the static methods to work.
 
 static var current_menu : CanvasLayer
 static var scene_tree : SceneTree

diff --git a/Extras/Scripts/CaptureMouse.gd b/Extras/Scripts/CaptureMouse.gd
@@ -1,6 +1,6 @@
 class_name CaptureMouse
 extends Control
-## Node that captures the mouse for games that require it. 
+## Control node that captures the mouse for games that require it. 
 ##
 ## Used for games that use the mouse to move the camera (ex. FPS or third-person shooters).