From f2c70d582a72e5c0ba98083d97916ae6ce316a13 Mon Sep 17 00:00:00 2001
From: Aiken Harris <harraiken91@gmail.com>
Date: Mon, 18 May 2026 20:16:49 +0200
Subject: [PATCH] Update doxygen comments for RTC and timer functions

---
 xtoskrnl/hl/x86/rtc.cc   |  4 ++--
 xtoskrnl/hl/x86/timer.cc | 12 ++++++++----
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/xtoskrnl/hl/x86/rtc.cc b/xtoskrnl/hl/x86/rtc.cc
index 1eebd1c..324c836 100644
--- a/xtoskrnl/hl/x86/rtc.cc
+++ b/xtoskrnl/hl/x86/rtc.cc
@@ -15,7 +15,7 @@
  * @param Time
  *        Supplies a pointer to a structure to receive the system time.
  *
- * @return This routine returns the status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */
@@ -192,7 +192,7 @@ HL::Rtc::GetRealTimeClock(OUT PTIME_FIELDS Time)
  * @param Time
  *        Supplies a pointer to a structure with populated data and time.
  *
- * @return This routine returns the status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */
diff --git a/xtoskrnl/hl/x86/timer.cc b/xtoskrnl/hl/x86/timer.cc
index 7aad052..c4aad42 100644
--- a/xtoskrnl/hl/x86/timer.cc
+++ b/xtoskrnl/hl/x86/timer.cc
@@ -12,7 +12,7 @@
 /**
  * Calibrates the Local APIC timer frequency.
  *
- * @return This routine returns a status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */
@@ -104,6 +104,10 @@ HL::Timer::CalibrateTscCounter(VOID)
  *
  * @param HardwareDivider
  *        Supplies the programmed threshold/divider for the interrupt generation.
+ *
+ * @return This routine does not return any value.
+ *
+ * @since XT 1.0
  */
 XTAPI
 VOID
@@ -124,7 +128,7 @@ HL::Timer::ConfigureTimeIncrement(IN ULONGLONG BaseFrequency, IN ULONGLONG Hardw
  * Initializes the High Precision Event Timer (HPET) by discovering its ACPI configuration and mapping
  * its hardware registers into the kernel's virtual address space.
  *
- * @return This routine returns a status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */
@@ -388,7 +392,7 @@ HL::Timer::InitializeApicTimer(VOID)
 /**
  * Initializes the High Precision Event Timer (HPET) Timer.
  *
- * @return This routine returns a status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */
@@ -446,7 +450,7 @@ HL::Timer::InitializeHpetTimer(VOID)
 /**
  * Initializes the legacy Programmable Interval Timer (PIT).
  *
- * @return This routine returns a status code.
+ * @return This routine returns a status code indicating the success or failure of the operation.
  *
  * @since XT 1.0
  */