From 7496c7203d664cd457d1d33aa27614b7be72b689 Mon Sep 17 00:00:00 2001
From: belliash <belliash@codingworkshop.eu.org>
Date: Thu, 22 Dec 2022 23:29:16 +0100
Subject: [PATCH] Add missing routines documentation

---
 xtldr/modules/xtos/xtos.c | 13 +++++++++++++
 xtldr/xtldr.c             | 17 +++++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/xtldr/modules/xtos/xtos.c b/xtldr/modules/xtos/xtos.c
index 8762c37..b5bb602 100644
--- a/xtldr/modules/xtos/xtos.c
+++ b/xtldr/modules/xtos/xtos.c
@@ -238,6 +238,19 @@ XtpBootSequence(IN PEFI_FILE_HANDLE BootDir,
     return STATUS_EFI_SUCCESS;
 }
 
+/**
+ * Initializes and maps the kernel initialization block.
+ *
+ * @param MemoryMappings
+ *        Supplies a pointer to linked list containing all memory mappings.
+ *
+ * @param VirtualAddress
+ *        Supplies a pointer to the next valid, free and available virtual address.
+ *
+ * @return This routine returns a status code.
+ *
+ * @since XT 1.0
+ */
 EFI_STATUS
 XtpInitializeLoaderBlock(IN PLIST_ENTRY MemoryMappings,
                          IN PVOID *VirtualAddress)
diff --git a/xtldr/xtldr.c b/xtldr/xtldr.c
index d89c135..9e7a359 100644
--- a/xtldr/xtldr.c
+++ b/xtldr/xtldr.c
@@ -28,6 +28,16 @@ PVOID EfiLoaderStack;
 CPPORT EfiSerialPort;
 
 
+/**
+ * Gets a pointer to the stack address.
+ *
+ * @param Stack
+ *        Supplies a pointer to the memory area where address to the current stack will be stored.
+ *
+ * @return This routine does not return any value.
+ *
+ * @since XT 1.0
+ */
 VOID BlGetStackPointer(OUT PVOID *Stack)
 {
     *Stack = EfiLoaderStack;
@@ -348,6 +358,13 @@ BlRegisterXtLoaderProtocol()
                                                                   &EfiLdrProtocol);
 }
 
+/**
+ * Callback routine called right after new stack is created.
+ *
+ * @return This routine returns a status code.
+ *
+ * @since XT 1.0
+ */
 EFI_STATUS
 BlStartNewStack()
 {