Merge pull request #11117 from cbscribe/kcc_timer_doc

Update Timer class ref.

1 files changed, 11 insertions, 7 deletions

diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 5d544c23e5..2a9350bbdc 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -53226,10 +53226,10 @@
 </class>
 <class name="Timer" inherits="Node" category="Core">
 	<brief_description>
-		A simple Timer node.
+		A countdown timer.
 	</brief_description>
 	<description>
-		Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop.
+		Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode.
 	</description>
 	<methods>
 		<method name="get_time_left" qualifiers="const">
@@ -53329,40 +53329,44 @@
 			<return type="void">
 			</return>
 			<description>
-				Start the timer.
+				Start the Timer.
 			</description>
 		</method>
 		<method name="stop">
 			<return type="void">
 			</return>
 			<description>
-				Stop (cancel) the timer.
+				Stop (cancel) the Timer.
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="autostart" type="bool" setter="set_autostart" getter="has_autostart" brief="">
+			If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code].
 		</member>
 		<member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot" brief="">
+			If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code].
 		</member>
 		<member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" brief="" enum="Timer.TimerProcessMode">
+			Processing mode. Uses TIMER_PROCESS_* constants as value.
 		</member>
 		<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" brief="">
+			Wait time in seconds.
 		</member>
 	</members>
 	<signals>
 		<signal name="timeout">
 			<description>
-				Emitted when the time runs out.
+				Emitted when the Timer reaches 0.
 			</description>
 		</signal>
 	</signals>
 	<constants>
 		<constant name="TIMER_PROCESS_FIXED" value="0">
-			Update the timer at fixed intervals (framerate processing).
+			Update the Timer at fixed intervals (framerate processing).
 		</constant>
 		<constant name="TIMER_PROCESS_IDLE" value="1">
-			Update the timer during the idle time at each frame.
+			Update the Timer during the idle time at each frame.
 		</constant>
 	</constants>
 </class>