Add missing documentation and fix formatting

xtoskrnl/ke/bootinfo.cc

@@ -97,6 +97,13 @@ KE::BootInformation::GetKernelParameter(IN PCWSTR ParameterName,
     return STATUS_NOT_FOUND;
 }
 
+/**
+ * Retrieves a pointer to the list of memory descriptors.
+ *
+ * @return This routine returns a pointer to the list of memory descriptors.
+ *
+ * @since XT 1.0
+ */
 XTAPI
 PLIST_ENTRY
 KE::BootInformation::GetMemoryDescriptors(VOID)

xtoskrnl/rtl/amd64/exsup.cc

@@ -10,6 +10,25 @@
 #include <xtos.hh>
 
 
+/**
+ * Handles SEH structured exception frames.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record.
+ *
+ * @param EstablisherFrame
+ *        The address of the base of the fixed stack allocation.
+ *
+ * @param ContextRecord
+ *       A pointer to the context record at the time the exception was raised.
+ *
+ * @param DispatcherContext
+ *      A pointer to the dispatcher context for the function.
+ *
+ * @return This routine returns an exception disposition value if the exception was not handled by any filter.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTAPI
 EXCEPTION_DISPOSITION
@@ -24,10 +43,29 @@ __C_specific_handler(IN PEXCEPTION_RECORD ExceptionRecord,
     return ExceptionContinueExecution;
 }
 
+/**
+ * Handles C++ structured exception frames. This implementation displays a panic screen and halts the system.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record that is passed to the possible catch statements.
+ *
+ * @param EstablisherFrame
+ *        A pointer to the stack frame that is used to handle the exception.
+ *
+ * @param ContextRecord
+ *       A pointer to the context record (not used on Intel CPUs).
+ *
+ * @param DispatcherContext
+ *      A pointer to the dispatcher provding information about function entry and stack frame (not used on Intel CPUs).
+ *
+ * @return This routine returns an exception disposition value if the exception was not handled by any filter.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 EXCEPTION_DISPOSITION
- __CxxFrameHandler3(IN PEXCEPTION_RECORD ExceptionRecord,
+__CxxFrameHandler3(IN PEXCEPTION_RECORD ExceptionRecord,
                    IN PVOID EstablisherFrame,
                    IN OUT PCONTEXT ContextRecord,
                    IN OUT PVOID DispatcherContext)
@@ -42,13 +80,32 @@ EXCEPTION_DISPOSITION
     return ExceptionContinueSearch;
 }
 
+/**
+ * Finds the appropriate exception handler to process the current exception.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record providing information about the specific exception.
+ *
+ * @param Registration
+ *        A pointer to the record that indicates which scope table should be used to find the exception handler.
+ *
+ * @param Context
+ *        Reserved.
+ *
+ * @param Dispatcher
+ *        Reserved.
+ *
+ * @return This routine returns DISPOSITION_DISMISS or DISPOSITION_CONTINUE_SEARCH.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 INT
-_except_handler3(PEXCEPTION_RECORD ExceptionRecord,
-                 PVOID Registration,
-                 PCONTEXT Context,
-                 PVOID Dispatcher)
+_except_handler3(IN PEXCEPTION_RECORD ExceptionRecord,
+                 IN PVOID Registration,
+                 IN PCONTEXT Context,
+                 IN PVOID Dispatcher)
 {
     UNIMPLEMENTED;
 
@@ -56,6 +113,13 @@ _except_handler3(PEXCEPTION_RECORD ExceptionRecord,
     return 0;
 }
 
+/**
+ * Handles pure virtual function call error. This implementation displays a panic screen and halts the system.
+ *
+ * @return This function does not return any value.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 VOID

xtoskrnl/rtl/i686/exsup.cc

@@ -10,6 +10,25 @@
 #include <xtos.hh>
 
 
+/**
+ * Handles SEH structured exception frames.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record.
+ *
+ * @param EstablisherFrame
+ *        The address of the base of the fixed stack allocation.
+ *
+ * @param ContextRecord
+ *       A pointer to the context record at the time the exception was raised.
+ *
+ * @param DispatcherContext
+ *      A pointer to the dispatcher context for the function.
+ *
+ * @return This routine returns an exception disposition value if the exception was not handled by any filter.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 EXCEPTION_DISPOSITION
@@ -24,10 +43,29 @@ __C_specific_handler(IN PEXCEPTION_RECORD ExceptionRecord,
     return ExceptionContinueExecution;
 }
 
+/**
+ * Handles C++ structured exception frames. This implementation displays a panic screen and halts the system.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record that is passed to the possible catch statements.
+ *
+ * @param EstablisherFrame
+ *        A pointer to the stack frame that is used to handle the exception.
+ *
+ * @param ContextRecord
+ *       A pointer to the context record (not used on Intel CPUs).
+ *
+ * @param DispatcherContext
+ *      A pointer to the dispatcher provding information about function entry and stack frame (not used on Intel CPUs).
+ *
+ * @return This routine returns an exception disposition value if the exception was not handled by any filter.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 EXCEPTION_DISPOSITION
- __CxxFrameHandler3(IN PEXCEPTION_RECORD ExceptionRecord,
+__CxxFrameHandler3(IN PEXCEPTION_RECORD ExceptionRecord,
                    IN PVOID EstablisherFrame,
                    IN OUT PCONTEXT ContextRecord,
                    IN OUT PVOID DispatcherContext)
@@ -42,13 +80,32 @@ EXCEPTION_DISPOSITION
     return ExceptionContinueSearch;
 }
 
+/**
+ * Finds the appropriate exception handler to process the current exception.
+ *
+ * @param ExceptionRecord
+ *        A pointer to the exception record providing information about the specific exception.
+ *
+ * @param Registration
+ *        A pointer to the record that indicates which scope table should be used to find the exception handler.
+ *
+ * @param Context
+ *        Reserved.
+ *
+ * @param Dispatcher
+ *        Reserved.
+ *
+ * @return This routine returns DISPOSITION_DISMISS or DISPOSITION_CONTINUE_SEARCH.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 INT
-_except_handler3(PEXCEPTION_RECORD ExceptionRecord,
-                 PVOID Registration,
-                 PCONTEXT Context,
-                 PVOID Dispatcher)
+_except_handler3(IN PEXCEPTION_RECORD ExceptionRecord,
+                 IN PVOID Registration,
+                 IN PCONTEXT Context,
+                 IN PVOID Dispatcher)
 {
     UNIMPLEMENTED;
 
@@ -56,6 +113,13 @@ _except_handler3(PEXCEPTION_RECORD ExceptionRecord,
     return 0;
 }
 
+/**
+ * Handles pure virtual function call error. This implementation displays a panic screen and halts the system.
+ *
+ * @return This function does not return any value.
+ *
+ * @since XT 1.0
+ */
 XTCLINK
 XTCDECL
 VOID