From 8af6adc6d7b028bc9712af4b9fa870fd65a445a4 Mon Sep 17 00:00:00 2001
From: Elia Sulimanov <eliasulimanov@gmail.com>
Date: Mon, 15 Jun 2020 16:03:27 +0300
Subject: [PATCH] Done FullScreenCanvas api docs

---
 .../Graphics/FullScreenCanvas.cs              | 36 +++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/source/Cosmos.System2/Graphics/FullScreenCanvas.cs b/source/Cosmos.System2/Graphics/FullScreenCanvas.cs
index d2886833f..a849edc49 100644
--- a/source/Cosmos.System2/Graphics/FullScreenCanvas.cs
+++ b/source/Cosmos.System2/Graphics/FullScreenCanvas.cs
@@ -1,12 +1,23 @@
 //#define COSMOSDEBUG
 using Cosmos.HAL;
+using sys = System;
 
 namespace Cosmos.System.Graphics
 {
+    /// <summary>
+    /// FullScreenCanvas class. Used to set and get full screen canvas.
+    /// </summary>
     public static class FullScreenCanvas
     {
+        /// <summary>
+        /// SVGA 2 device.
+        /// </summary>
         private static PCIDevice SVGAIIDevice = PCI.GetDevice(VendorID.VMWare, DeviceID.SVGAIIAdapter);
 
+        /// <summary>
+        /// Check if SVGA 2 Exists.
+        /// </summary>
+        /// <returns>bool value.</returns>
         public static bool SVGAIIExist()
         {
             if (SVGAIIDevice == null)
@@ -17,8 +28,16 @@ namespace Cosmos.System.Graphics
             return SVGAIIDevice.DeviceExists;
         }
 
+        /// <summary>
+        /// Video driver.
+        /// </summary>
         private static Canvas MyVideoDriver = null;
 
+        /// <summary>
+        /// Get video driver.
+        /// </summary>
+        /// <returns>Canvas value.</returns>
+        /// <exception cref="sys.ArgumentOutOfRangeException">Thrown if default graphics mode is not suppoted.</exception>
         private static Canvas GetVideoDriver()
         {
             if (SVGAIIExist())
@@ -31,6 +50,12 @@ namespace Cosmos.System.Graphics
             }
         }
 
+        /// <summary>
+        /// Get video driver.
+        /// </summary>
+        /// <param name="mode">Mode.</param>
+        /// <returns>Canvas value.</returns>
+        /// <exception cref="sys.ArgumentOutOfRangeException">Thrown if graphics mode is not suppoted.</exception>
         private static Canvas GetVideoDriver(Mode mode)
         {
             if (SVGAIIExist())
@@ -43,6 +68,11 @@ namespace Cosmos.System.Graphics
             }
         }
 
+        /// <summary>
+        /// Get full screen canvas.
+        /// </summary>
+        /// <returns>Canvas value.</returns>
+        /// <exception cref="sys.ArgumentOutOfRangeException">Thrown if default graphics mode is not suppoted.</exception>
         public static Canvas GetFullScreenCanvas()
         {
             Global.mDebugger.SendInternal($"GetFullScreenCanvas() with default mode");
@@ -59,6 +89,12 @@ namespace Cosmos.System.Graphics
             }
         }
 
+        /// <summary>
+        /// Get full screen canvas.
+        /// </summary>
+        /// <param name="mode">Mode.</param>
+        /// <returns>Canvas value.</returns>
+        /// <exception cref="sys.ArgumentOutOfRangeException">Thrown if graphics mode is not suppoted.</exception>
         public static Canvas GetFullScreenCanvas(Mode mode)
         {
             Global.mDebugger.SendInternal($"GetFullScreenCanvas() with mode" + mode);