From 4a4e2f7c72301ba1dfb207f00c7c2fa0e9674223 Mon Sep 17 00:00:00 2001
From: gdkchan <gab.dark.100@gmail.com>
Date: Tue, 31 Dec 2019 16:19:44 -0300
Subject: Add XML documentation to Ryujinx.Graphics.Gpu.Engine

---
 Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs')

diff --git a/Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs b/Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs
index 8d1ebebe..79432395 100644
--- a/Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs
+++ b/Ryujinx.Graphics.Gpu/Engine/Inline2Memory.cs
@@ -19,6 +19,11 @@ namespace Ryujinx.Graphics.Gpu.Engine
 
         private int[] _buffer;
 
+        /// <summary>
+        /// Launches Inline-to-Memory engine DMA copy.
+        /// </summary>
+        /// <param name="state">Current GPU state</param>
+        /// <param name="argument">Method call argument</param>
         public void LaunchDma(GpuState state, int argument)
         {
             _params = state.Get<Inline2MemoryParams>(MethodOffset.I2mParams);
@@ -42,6 +47,11 @@ namespace Ryujinx.Graphics.Gpu.Engine
             _finished = false;
         }
 
+        /// <summary>
+        /// Pushes a word of data to the Inline-to-Memory engine.
+        /// </summary>
+        /// <param name="state">Current GPU state</param>
+        /// <param name="argument">Method call argument</param>
         public void LoadInlineData(GpuState state, int argument)
         {
             if (!_finished)
@@ -55,6 +65,9 @@ namespace Ryujinx.Graphics.Gpu.Engine
             }
         }
 
+        /// <summary>
+        /// Performs actual copy of the inline data after the transfer is finished.
+        /// </summary>
         private void FinishTransfer()
         {
             Span<byte> data = MemoryMarshal.Cast<int, byte>(_buffer).Slice(0, _size);
-- 
cgit v1.2.3