Mosa.DeviceDriver: XML comment refactoring

Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs

@@ -11,6 +11,9 @@ namespace Mosa.DeviceDriver.ACPI;
 //https://wiki.osdev.org/ACPI
 //https://wiki.osdev.org/MADT
 
+/// <summary>
+/// A basic implementation of ACPI. It implements the <see cref="IACPI"/> interface.
+/// </summary>
 public class ACPIDriver : BaseDeviceDriver, IACPI
 {
 	private FADT fadt;

Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// A standard ACPI header, which is the base of all other headers (like the <see cref="FADT"/> for example).
+/// </summary>
 public readonly struct ACPISDTHeader
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/FADT.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The Fixed ACPI Description Table.
+/// </summary>
 public readonly struct FADT
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs

@@ -4,6 +4,10 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI Generic Address Structure. It describes in which address space a register is located (e.g. MMIO, Port IO, PCI configuration
+/// space, etc...)
+/// </summary>
 public readonly struct GenericAddressStructure
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// Describes an I/O APIC entry in the ACPI MADT.
+/// </summary>
 public readonly struct IOAPICEntry
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// Describes a long local APIC entry in the ACPI MADT.
+/// </summary>
 public readonly struct LongLocalAPICEntry
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/MADT.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI Multiple APIC Description Table.
+/// </summary>
 public readonly struct MADT
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// A generic entry in the ACPI MADT, which is the base of all other entries (like the <see cref="IOAPICEntry"/> for example).
+/// </summary>
 public readonly struct MADTEntry
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// Describes a processor local APIC entry in the ACPI MADT.
+/// </summary>
 public readonly struct ProcessorLocalAPICEntry
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI Root System Description Pointer.
+/// </summary>
 public readonly struct RSDPDescriptor
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI Root System Description Pointer v2 (also known as the eXtended System Description Pointer, or XSDP).
+/// </summary>
 public readonly struct RSDPDescriptor20
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/RSDT.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI Root System Description Table.
+/// </summary>
 public readonly struct RSDT
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ACPI/XSDT.cs

@@ -4,6 +4,9 @@
 
 namespace Mosa.DeviceDriver.ACPI;
 
+/// <summary>
+/// The ACPI eXtended System Description Table.
+/// </summary>
 public readonly struct XSDT
 {
 	public readonly Pointer Pointer;

Source/Mosa.DeviceDriver/ISA/IDEController.cs

@@ -11,7 +11,7 @@ namespace Mosa.DeviceDriver.ISA;
 // http://mirrors.josefsipek.net/www.nondot.org/sabre/os/files/Disk/IDE-tech.html
 
 /// <summary>
-/// IDE Controller
+/// Implements an IDE controller in ATA PIO mode. It also implements the <see cref="IDiskControllerDevice"/> interface.
 /// </summary>
 //[ISADeviceDriver(AutoLoad = true, BasePort = 0x1F0, PortRange = 8, Platforms = PlatformArchitecture.X86AndX64)]
 //[ISADeviceDriver(AutoLoad = false, BasePort = 0x170, PortRange = 8, ForceOption = "ide2", Platforms = PlatformArchitecture.X86AndX64)]

Source/Mosa.DeviceDriver/ISA/ISABus.cs

@@ -9,7 +9,7 @@
 namespace Mosa.DeviceDriver.ISA;
 
 /// <summary>
-/// ISA Bus Driver
+/// A device driver whose sole purpose is to initialize all ISA devices in the system.
 /// </summary>
 public class ISABus : BaseDeviceDriver
 {

Source/Mosa.DeviceDriver/ISA/PCIController.cs

@@ -7,7 +7,8 @@
 namespace Mosa.DeviceDriver.ISA;
 
 /// <summary>
-/// PCI Controller
+/// A device driver which queries the PCI controller in the system. It implements both the <see cref="IPCIController"/> and the
+/// <see cref="IPCIControllerLegacy"/> interfaces.
 /// </summary>
 //[ISADeviceDriver(AutoLoad = true, BasePort = 0x0CF8, PortRange = 8, Platforms = PlatformArchitecture.X86AndX64)]
 public sealed class PCIController : BaseDeviceDriver, IPCIControllerLegacy, IPCIController

Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs

@@ -7,8 +7,8 @@
 namespace Mosa.DeviceDriver.ISA;
 
 /// <summary>
-/// A standard PS/2 keyboard. It implements the IKeyboardDevice interface, and uses a FIFO (First In First Out) buffer to store
-/// the raw scancodes, which can be retrieved using the GetScanCode() function.
+/// A standard PS/2 keyboard. It implements the <see cref="IKeyboardDevice"/> interface, and uses a FIFO (First In First Out) buffer to
+/// store the raw scancodes, which can be retrieved using the GetScanCode() method.
 /// </summary>
 //[ISADeviceDriver(AutoLoad = true, BasePort = 0x60, PortRange = 1, AltBasePort = 0x64, AltPortRange = 1, IRQ = 1, Platforms = PlatformArchitecture.X86AndX64)]
 public class StandardKeyboard : BaseDeviceDriver, IKeyboardDevice

Source/Mosa.DeviceDriver/ISA/StandardMouse.cs

@@ -11,6 +11,9 @@ namespace Mosa.DeviceDriver.ISA;
 //https://forum.osdev.org/viewtopic.php?t=10247
 //https://wiki.osdev.org/Mouse_Input
 
+/// <summary>
+/// A standard PS/2 mouse. It implements the <see cref="IMouseDevice"/> interface.
+/// </summary>
 public class StandardMouse : BaseDeviceDriver, IMouseDevice
 {
 	private enum WaitType

Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs

@@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel;
 //http://download.intel.com/design/chipsets/specupdt/29765406.pdf
 
 /// <summary>
+/// A generic Intel chipset, implemented by QEMU (also known as i440FX). It uses the <see cref="IntelPIIX3"/> southbridge.
 /// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x1237, Platforms = PlatformArchitecture.X86AndX64)]
 public class Intel440FX : BaseDeviceDriver

Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetDRAMController.cs

@@ -4,9 +4,6 @@
 
 namespace Mosa.DeviceDriver.PCI.Intel;
 
-/// <summary>
-/// Intel
-/// </summary>
 public class Intel4SeriesChipsetDRAMController : BaseDeviceDriver
 {
 	public override void Initialize() => Device.Name = "Intel4SeriesChipsetDRAMController";

Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController.cs

@@ -4,9 +4,6 @@
 
 namespace Mosa.DeviceDriver.PCI.Intel;
 
-/// <summary>
-/// Intel
-/// </summary>
 public class Intel4SeriesChipsetIntegratedGraphicsController : BaseDeviceDriver
 {
 	public override void Initialize() => Device.Name = "Intel4SeriesChipsetIntegratedGraphicsController";

Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController2E13.cs

@@ -4,9 +4,6 @@
 
 namespace Mosa.DeviceDriver.PCI.Intel;
 
-/// <summary>
-/// Intel
-/// </summary>
 public class Intel4SeriesChipsetIntegratedGraphicsController2E13 : BaseDeviceDriver
 {
 	public override void Initialize() => Device.Name = "Intel4SeriesChipsetIntegratedGraphicsController2E13";

Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs

@@ -4,9 +4,6 @@
 
 namespace Mosa.DeviceDriver.PCI.Intel;
 
-/// <summary>
-/// Intel
-/// </summary>
 public class Intel4SeriesChipsetPCIExpressRootPort : BaseDeviceDriver
 {
 	public override void Initialize() => Device.Name = "Intel4SeriesChipsetPCIExpressRootPort";

Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs

@@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel;
 //http://download.intel.com/design/intarch/datashts/29055002.pdf
 
 /// <summary>
+/// The southbridge of the generic Intel chipset <see cref="Intel440FX"/>.
 /// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7000, Platforms = PlatformArchitecture.X86AndX64)]
 public class IntelPIIX3 : BaseDeviceDriver

Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs

@@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel;
 //http://www.intel.com/assets/pdf/datasheet/290562.pdf
 
 /// <summary>
+/// A newer version of the <see cref="IntelPIIX3"/> southbridge, supporting most notably ACPI.
 /// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7113, Platforms = PlatformArchitecture.X86AndX64)]
 public class IntelPIIX4 : BaseDeviceDriver

Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs

@@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel;
 //http://www.intel.com/assets/pdf/datasheet/290562.pdf
 
 /// <summary>
+/// The IDE controller for the <see cref="IntelPIIX4"/> southbridge, interfacing via PCI.
 /// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7010, Platforms = PlatformArchitecture.X86AndX64)]
 //Base Class Code: 01h=Mass storage device.

Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelGPIOController.cs

@@ -6,8 +6,6 @@ namespace Mosa.DeviceDriver.PCI.Intel.QuarkSoC;
 
 //http://download.intel.com/support/processors/quark/sb/quarkdatasheetrev02.pdf
 
-/// <summary>
-/// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x0934, ClassCode = 0X0C, SubClassCode = 0x80, ProgIF = 0x00, RevisionID = 0x10, Platforms = PlatformArchitecture.X86AndX64)]
 public class IntelGPIOController : BaseDeviceDriver
 {

Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs

@@ -6,8 +6,6 @@ namespace Mosa.DeviceDriver.PCI.Intel.QuarkSoC;
 
 //http://download.intel.com/support/processors/quark/sb/quarkdatasheetrev02.pdf
 
-/// <summary>
-/// </summary>
 //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x0936, ClassCode = 0X07, SubClassCode = 0x80, ProgIF = 0x02, RevisionID = 0x10, Platforms = PlatformArchitecture.X86AndX64)]
 public class IntelHSUART : BaseDeviceDriver
 {

Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs

@@ -26,7 +26,7 @@ namespace Mosa.DeviceDriver.PCI.VMware;
 //https://github.com/prepare/vmware-svga
 
 /// <summary>
-/// VMware SVGA II Device Driver
+/// A basic implementation of the VMware SVGA-II device. It also implements the <see cref="IGraphicsDevice"/> interface.
 /// </summary>
 //[PCIDeviceDriver(VendorID = 0x15AD, DeviceID = 0x0405, Platforms = PlatformArchitecture.X86AndX64)]
 public class VMwareSVGA2 : BaseDeviceDriver, IGraphicsDevice

Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs

@@ -9,6 +9,10 @@
 
 namespace Mosa.DeviceDriver.PCI.VirtIO.Devices;
 
+/// <summary>
+/// A bare bones (framebuffer-only) implementation of the VirtIO GPU device. It also implements the <see cref="IGraphicsDevice"/>
+/// interface.
+/// </summary>
 public class VirtIOGPU : BaseDeviceDriver, IGraphicsDevice
 {
 	private static class Features

Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs

@@ -5,7 +5,7 @@
 namespace Mosa.DeviceDriver.ScanCodeMap;
 
 /// <summary>
-/// Implements the HU Keyboard map.
+/// Implements a Hungarian QWERTZ scan code map.
 /// </summary>
 public class HU : IScanCodeMap
 {

Source/Mosa.DeviceDriver/ScanCodeMap/US.cs

@@ -5,7 +5,7 @@
 namespace Mosa.DeviceDriver.ScanCodeMap;
 
 /// <summary>
-/// Implements the US Keyboard map (scan code set 2)
+/// Implements a QWERTY scan code map. (https://wiki.osdev.org/PS/2_Keyboard#Scan_Code_Set_1)
 /// </summary>
 public class US : IScanCodeMap
 {

Source/Mosa.DeviceDriver/Setup.cs

@@ -9,6 +9,12 @@
 
 namespace Mosa.DeviceDriver;
 
+/// <summary>
+/// Includes a method to get all device drivers that should be initialized by a kernel. Note that this is only a helper method and a
+/// kernel may not use it, and may choose to load specific drivers instead. In a future release however, this method will be removed
+/// in favor of having an attribute associated to each device driver class, effectively telling which device drivers are registered for
+/// initialization.
+/// </summary>
 public static class Setup
 {
 	public static List<DeviceDriverRegistryEntry> GetDeviceDriverRegistryEntries() => new List<DeviceDriverRegistryEntry>

Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs

@@ -7,9 +7,9 @@ namespace Mosa.DeviceSystem.Fonts;
 /// <summary>
 /// An interface used for implementing simple fonts. Those can be fixed, like <see cref="ASC16Font"/>, or dynamic, like the
 /// <see cref="SimpleBitFont"/> format. It provides access to the name of the font, its fixed width/height/size (if any),
-/// and the charset it supports. It then allows drawing characters using the DrawChar() and DrawString() functions.
+/// and the charset it supports. It then allows drawing characters using the DrawChar() and DrawString() methods.
 /// To reliably calculate the total width of a character or string, or the height of a character, respectively use the
-/// CalculateWidth() and CalculateHeight() functions.
+/// CalculateWidth() and CalculateHeight() methods.
 /// </summary>
 public interface ISimpleFont
 {

Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs

@@ -9,8 +9,8 @@
 namespace Mosa.DeviceSystem.Graphics;
 
 /// <summary>
-/// A 32 bpp versatile frame buffer that works with physical and virtual outputs. Given two X and Y coordinates, the lambda function
-/// GetOffset provides the correct offset within the buffer. This frame buffer implements software-accelerated drawing functions.
+/// A 32 bpp versatile frame buffer that works with physical and virtual outputs. Given two X and Y coordinates, the lambda method
+/// GetOffset provides the correct offset within the buffer. This frame buffer implements software-accelerated drawing methods.
 /// For hardware-accelerated ones, check the graphics device driver you're using.
 /// </summary>
 public sealed class FrameBuffer32

Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs

@@ -9,7 +9,7 @@ namespace Mosa.DeviceSystem.HardwareAbstraction;
 /// <summary>
 /// A static class used throughout the code base to call the hardware abstraction layer. It internally sets an instance of a
 /// <see cref="BaseHardwareAbstraction"/> class, and effectively does nothing more than that, except from providing a
-/// <see cref="HandleInterrupt"/> delegate function to handle interrupts coming from anywhere.
+/// <see cref="HandleInterrupt"/> delegate method to handle interrupts coming from anywhere.
 /// </summary>
 public static class HAL
 {
@@ -22,7 +22,7 @@ public static class HAL
 
 	public static void Set(BaseHardwareAbstraction abstraction) => hardwareAbstraction = abstraction;
 
-	public static void SetInterruptHandler(HandleInterrupt function) => handleInterrupt = function;
+	public static void SetInterruptHandler(HandleInterrupt method) => handleInterrupt = method;
 
 	public static void ProcessInterrupt(byte irq) => handleInterrupt?.Invoke(irq);
 

Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs

@@ -7,7 +7,7 @@
 namespace Mosa.DeviceSystem.Misc;
 
 /// <summary>
-/// Provides access to a sized region in memory, using a <see cref="Pointer"/>. It also provides functions for directly reading and
+/// Provides access to a sized region in memory, using a <see cref="Pointer"/>. It also provides methods for directly reading and
 /// writing 24-bit integers.
 /// </summary>
 public readonly struct ConstrainedPointer

Source/Mosa.DeviceSystem/Misc/DataBlock.cs

@@ -5,8 +5,8 @@
 namespace Mosa.DeviceSystem.Misc;
 
 /// <summary>
-/// Provides functions for reading and writing specific sized types of data (e.g. various sized integers or byte arrays). It also
-/// provides functions for writing those types in a reserved endianness.
+/// Provides methods for reading and writing specific sized types of data (e.g. various sized integers or byte arrays). It also
+/// provides methods for writing those types in a reserved endianness.
 /// </summary>
 public class DataBlock
 {

Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs

@@ -5,7 +5,7 @@ namespace Mosa.DeviceSystem.Mouse;
 /// <summary>
 /// An interface used for interacting directly with a mouse device. It provides access to the device's raw X and Y coordinates,
 /// as well as its current state. It is important to provide the screen resolution to the mouse using the SetScreenResolution()
-/// function first before using the driver.
+/// method first before using the driver.
 /// </summary>
 public interface IMouseDevice
 {

Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs

@@ -8,7 +8,7 @@ namespace Mosa.DeviceSystem.TextDevice;
 /// <summary>
 /// A class used for interacting with a text screen (like a TTY), using an <see cref="ITextDevice"/> and an <see cref="IKeyboard"/>.
 /// It can do pretty much everything except reading specific characters at a given cursor position (however, it can sequentially read
-/// a line using the ReadLine() function).
+/// a line using the ReadLine() method).
 /// </summary>
 public class TextScreen
 {