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

Update doxygen comments and formatting

Browse Source
This commit is contained in:
Aiken Harris
2026-05-20 20:52:52 +02:00
parent fe2e78f3c7
commit 72a03f641d
22 changed files with 72 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
xtoskrnl/ke/apc.cc
View File

@@ -38,7 +38,7 @@
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID

4
xtoskrnl/ke/bootinfo.cc
View File

@@ -46,7 +46,7 @@ KE::BootInformation::GetFirmwareType(VOID)
* @param Parameter
* Supplies a pointer to a variable that receives a pointer to the matching parameter, or NULLPTR if not found.
*
* @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
*/
@@ -116,7 +116,7 @@ KE::BootInformation::GetKernelParameter(IN PCWSTR ParameterName,
* @param BufferSize
* Supplies the size of the value buffer, in wide characters.
*
* @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
*/

10
xtoskrnl/ke/dpc.cc
View File

@@ -23,7 +23,7 @@
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID
@@ -56,7 +56,7 @@ KE::Dpc::InitializeDpc(IN PKDPC Dpc,
*
* @return This routine does not return any value.
*
* @since NT 5.2
* @since XT 1.0
*/
XTAPI
VOID
@@ -86,7 +86,7 @@ KE::Dpc::InitializeThreadedDpc(IN PKDPC Dpc,
*
* @return This routine does not return any value.
*
* @since NT 4.0
* @since XT 1.0
*/
XTAPI
VOID
@@ -104,7 +104,7 @@ KE::Dpc::SetTargetProcessor(IN PKDPC Dpc,
*
* @return This routine does not return any value.
*
* @since NT 5.2
* @since XT 1.0
*/
XTAPI
VOID
@@ -121,7 +121,7 @@ KE::Dpc::SignalCallDone(IN PVOID SystemArgument)
*
* @return This routine returns TRUE if just one processor is waiting on the barrier, FALSE if more.
*
* @since NT 5.2
* @since XT 1.0
*/
XTAPI
BOOLEAN

6
xtoskrnl/ke/event.cc
View File

@@ -17,7 +17,7 @@
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID
@@ -41,7 +41,7 @@ KE::Event::ClearEvent(IN PKEVENT Event)
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID
@@ -71,7 +71,7 @@ KE::Event::InitializeEvent(OUT PKEVENT Event,
*
* @return This routine returns the previous signal state of the event.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
LONG

9
xtoskrnl/ke/kprocess.cc
View File

@@ -9,6 +9,13 @@
#include <xtos.hh>
/**
* Retrieves a pointer to the system's initial executive process object.
*
* @return This routine returns a pointer to the initial executive process.
*
* @since XT 1.0
*/
XTAPI
PEPROCESS
KE::KProcess::GetInitialProcess(VOID)
@@ -36,7 +43,7 @@ KE::KProcess::GetInitialProcess(VOID)
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID

13
xtoskrnl/ke/kthread.cc
View File

@@ -9,6 +9,13 @@
#include <xtos.hh>
/**
* Retrieves a pointer to the system's initial executive thread object.
*
* @return This routine returns a pointer to the initial executive thread.
*
* @since XT 1.0
*/
XTAPI
PETHREAD
KE::KThread::GetInitialThread(VOID)
@@ -43,9 +50,9 @@ KE::KThread::GetInitialThread(VOID)
* @param Stack
* Supplies a pointer to the stack of the thread.
*
* @return This routine returns a status code.
* @return This routine returns a status code indicating the success or failure of the operation.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
XTSTATUS
@@ -189,7 +196,7 @@ KE::KThread::InitializeThread(IN PKPROCESS Process,
*
* @return This routine does not return any value.
*
* @since NT 5.1
* @since XT 1.0
*/
XTAPI
VOID

4
xtoskrnl/ke/semphore.cc
View File

@@ -23,7 +23,7 @@
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID
@@ -75,7 +75,7 @@ KE::Semaphore::ReadState(IN PKSEMAPHORE Semaphore)
*
* @return This routine returns a previous signal state of the semaphore.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
LONG

2
xtoskrnl/ke/spinlock.cc
View File

@@ -137,7 +137,7 @@ KE::SpinLock::InitializeLockQueues()
*
* @return This routine does not return any value.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
VOID

6
xtoskrnl/ke/sysres.cc
View File

@@ -18,7 +18,7 @@
* @param ResourceHeader
* Specifies a memory area where a pointer to the system resource header 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
*/
@@ -131,7 +131,7 @@ KE::SystemResources::GetSystemResource(IN SYSTEM_RESOURCE_TYPE ResourceType,
* @param ResourceHeader
* Specifies a memory area where a pointer to the system resource header 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
*/
@@ -147,7 +147,7 @@ KE::SystemResources::GetResource(IN SYSTEM_RESOURCE_TYPE ResourceType,
/**
* Initializes system resource management.
*
* @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
*/

4
xtoskrnl/ke/timer.cc
View File

@@ -17,7 +17,7 @@
*
* @return This routine returns TRUE if the cancelled timer was set, or FALSE otherwise.
*
* @since NT 3.5
* @since XT 1.0
*/
XTAPI
BOOLEAN
@@ -57,7 +57,7 @@ KE::Timer::CancelTimer(IN PKTIMER Timer)
*
* @return This routine does not return any value.
*
* @since NT 4.0
* @since XT 1.0
*/
XTAPI
VOID