From f7bcc884e46805f4dcda4fc7d7e7bccb2a3ac316 Mon Sep 17 00:00:00 2001
From: gdkchan <gab.dark.100@gmail.com>
Date: Tue, 31 Dec 2019 17:08:20 -0300
Subject: Add XML documentation to Ryujinx.Graphics.Gpu

---
 Ryujinx.Graphics.Gpu/MethodParams.cs | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

(limited to 'Ryujinx.Graphics.Gpu/MethodParams.cs')

diff --git a/Ryujinx.Graphics.Gpu/MethodParams.cs b/Ryujinx.Graphics.Gpu/MethodParams.cs
index fea4eb30..dd60f77c 100644
--- a/Ryujinx.Graphics.Gpu/MethodParams.cs
+++ b/Ryujinx.Graphics.Gpu/MethodParams.cs
@@ -1,14 +1,42 @@
 namespace Ryujinx.Graphics
 {
+    /// <summary>
+    /// Method call parameters.
+    /// </summary>
     struct MethodParams
     {
-        public int Method      { get; private set; }
-        public int Argument    { get; private set; }
-        public int SubChannel  { get; private set; }
-        public int MethodCount { get; private set; }
+        /// <summary>
+        /// Method offset.
+        /// </summary>
+        public int Method { get; }
 
+        /// <summary>
+        /// Method call argument.
+        /// </summary>
+        public int Argument { get; }
+
+        /// <summary>
+        /// Sub-channel where the call should be sent.
+        /// </summary>
+        public int SubChannel { get; }
+
+        /// <summary>
+        /// For multiple calls to the same method, this is the remaining calls count.
+        /// </summary>
+        public int MethodCount { get; }
+
+        /// <summary>
+        /// Indicates if the current call is the last one from a batch of calls to the same method.
+        /// </summary>
         public bool IsLastCall => MethodCount <= 1;
 
+        /// <summary>
+        /// Constructs the method call parameters structure.
+        /// </summary>
+        /// <param name="method">Method offset</param>
+        /// <param name="argument">Method call argument</param>
+        /// <param name="subChannel">Optional sub-channel where the method should be sent (not required for macro calls)</param>
+        /// <param name="methodCount">Optional remaining calls count (not required for macro calls)</param>
         public MethodParams(
             int method,
             int argument,
-- 
cgit v1.2.3