perikiyoxd/exectos
1
0
Fork 0
forked from xt-sys/exectos
Code Pull Requests Activity

Standardize doxygen return descriptions across HL layer

Browse Source
This commit is contained in:
Aiken Harris
2026-05-18 20:22:19 +02:00
parent f2c70d582a
commit d41c90f541
5 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
xtoskrnl/hl/acpi.cc
View File

@@ -50,7 +50,7 @@ HL::Acpi::CacheAcpiTable(IN PACPI_DESCRIPTION_HEADER AcpiTable)
* @param Rsdp * @param Rsdp
* Supplies a pointer to the memory area, where RSDP virtual address will be stored. * Supplies a pointer to the memory area, where RSDP virtual address will be stored.
* *
* @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 * @since XT 1.0
*/ */
@@ -72,7 +72,7 @@ HL::Acpi::GetAcpiSystemDescriptionPointer(OUT PACPI_RSDP *Rsdp)
* @param AcpiTable * @param AcpiTable
* Supplies a pointer to memory area where ACPI table virtual address will be stored. * Supplies a pointer to memory area where ACPI table virtual address will be stored.
* *
* @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 * @since XT 1.0
*/ */
@@ -148,7 +148,7 @@ HL::Acpi::GetSystemInformation(OUT PACPI_SYSTEM_INFO *SystemInfo)
/** /**
* Performs an initialization of the ACPI subsystem. * Performs an initialization of the ACPI subsystem.
* *
* @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 * @since XT 1.0
*/ */
@@ -185,7 +185,7 @@ HL::Acpi::InitializeAcpi(VOID)
/** /**
* Initializes the kernel's local ACPI cache storage. * Initializes the kernel's local ACPI cache storage.
* *
* @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 * @since XT 1.0
*/ */
@@ -220,7 +220,7 @@ HL::Acpi::InitializeAcpiCache(VOID)
* @param AcpiTable * @param AcpiTable
* Supplies a pointer to memory area where ACPI table virtual address will be stored. * Supplies a pointer to memory area where ACPI table virtual address will be stored.
* *
* @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 * @since XT 1.0
*/ */
@@ -326,7 +326,7 @@ HL::Acpi::InitializeAcpiSystemDescriptionTable(OUT PACPI_DESCRIPTION_HEADER *Acp
/** /**
* Initializes System Information structure based on the ACPI provided data. * Initializes System Information structure based on the ACPI provided data.
* *
* @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 * @since XT 1.0
*/ */
@@ -425,7 +425,7 @@ HL::Acpi::InitializeAcpiSystemInformation(VOID)
/** /**
* Initializes ACPI System Information data structure based on the size of available ACPI data. * Initializes ACPI System Information data structure based on the size of available ACPI data.
* *
* @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 * @since XT 1.0
*/ */
@@ -521,7 +521,7 @@ HL::Acpi::InitializeAcpiSystemStructure(VOID)
/** /**
* Initializes the ACPI Timer. * Initializes the ACPI 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 * @since XT 1.0
*/ */
@@ -568,7 +568,7 @@ HL::Acpi::InitializeAcpiTimer(VOID)
* @param AcpiTable * @param AcpiTable
* Supplies a pointer to memory area where ACPI table virtual address will be stored. * Supplies a pointer to memory area where ACPI table virtual address will be stored.
* *
* @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 * @since XT 1.0
*/ */
@@ -625,7 +625,7 @@ HL::Acpi::QueryAcpiCache(IN ULONG Signature,
* @param AcpiTable * @param AcpiTable
* Supplies a pointer to memory area where ACPI table virtual address will be stored. * Supplies a pointer to memory area where ACPI table virtual address will be stored.
* *
* @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 * @since XT 1.0
*/ */

6
xtoskrnl/hl/amd64/ioport.cc
View File

@@ -15,7 +15,7 @@
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -36,7 +36,7 @@ HL::IoPort::ReadPort8(IN USHORT Port)
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -57,7 +57,7 @@ HL::IoPort::ReadPort16(IN USHORT Port)
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */

8
xtoskrnl/hl/cport.cc
View File

@@ -24,7 +24,7 @@
* @param Poll * @param Poll
* Indicates whether to only poll, not reading the data. * Indicates whether to only poll, not reading the data.
* *
* @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 * @since XT 1.0
*/ */
@@ -98,7 +98,7 @@ HL::ComPort::ReadComPort(IN PCPPORT Port,
* @param Byte * @param Byte
* Value expected from the port. * Value expected from the port.
* *
* @return Byte read from COM port. * @return This routine returns a byte read from COM port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -144,7 +144,7 @@ HL::ComPort::ReadComPortLsr(IN PCPPORT Port,
* @param BaudRate * @param BaudRate
* Supplies an optional port baud rate. * Supplies an optional port baud rate.
* *
* @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 * @since XT 1.0
*/ */
@@ -240,7 +240,7 @@ HL::ComPort::InitializeComPort(IN OUT PCPPORT Port,
* @param Byte * @param Byte
* Data to be written. * Data to be written.
* *
* @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 * @since XT 1.0
*/ */

6
xtoskrnl/hl/fbdev.cc
View File

@@ -379,7 +379,7 @@ HL::FrameBuffer::DrawPixel(IN ULONG PositionX,
/** /**
* Enables the Shadow Buffer (Double Buffering) for high-performance rendering. * Enables the Shadow Buffer (Double Buffering) for high-performance rendering.
* *
* @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 * @since XT 1.0
*/ */
@@ -452,7 +452,7 @@ HL::FrameBuffer::GetFrameBufferResolution(OUT PULONG Width,
* @param Color * @param Color
* Specifies the color in (A)RGB format. * Specifies the color in (A)RGB format.
* *
* @return Returns the color in FrameBuffer format. * @return This routine returns the color in FrameBuffer format.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -476,7 +476,7 @@ HL::FrameBuffer::GetRGBColor(IN ULONG Color)
/** /**
* Initializes frame buffer display. * Initializes frame buffer display.
* *
* @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 * @since XT 1.0
*/ */

6
xtoskrnl/hl/i686/ioport.cc
View File

@@ -15,7 +15,7 @@
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -36,7 +36,7 @@ HL::IoPort::ReadPort8(IN USHORT Port)
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -57,7 +57,7 @@ HL::IoPort::ReadPort16(IN USHORT Port)
* @param Port * @param Port
* Specifies the address to read from, in the range of 0-0xFFFF. * Specifies the address to read from, in the range of 0-0xFFFF.
* *
* @return The value read from the port. * @return This routine returns the value read from the port.
* *
* @since XT 1.0 * @since XT 1.0
*/ */