From fcca8871fb459ad7d1291759dc8b61396cb3cfeb Mon Sep 17 00:00:00 2001
From: TSR Berry <20988865+TSRBerry@users.noreply.github.com>
Date: Sun, 5 Feb 2023 17:14:21 +0100
Subject: [PATCH] Adjust docstrings for CodecError.cs

---
 src/Ryujinx.Graphics.Nvdec.Vp9/CodecErr.cs | 83 +++++++++++++---------
 1 file changed, 51 insertions(+), 32 deletions(-)

diff --git a/src/Ryujinx.Graphics.Nvdec.Vp9/CodecErr.cs b/src/Ryujinx.Graphics.Nvdec.Vp9/CodecErr.cs
index 82658b4cf..9bcf4ac01 100644
--- a/src/Ryujinx.Graphics.Nvdec.Vp9/CodecErr.cs
+++ b/src/Ryujinx.Graphics.Nvdec.Vp9/CodecErr.cs
@@ -2,55 +2,74 @@
 {
     internal enum CodecErr
     {
-        /*!\brief Operation completed without error */
+        /// <summary>
+        /// Operation completed without error
+        /// </summary>
         Ok,
 
-        /*!\brief Unspecified error */
+        /// <summary>
+        /// Unspecified error
+        /// </summary>
         Error,
 
-        /*!\brief Memory operation failed */
+        /// <summary>
+        /// Memory operation failed
+        /// </summary>
         MemError,
 
-        /*!\brief ABI version mismatch */
+        /// <summary>
+        /// ABI version mismatch
+        /// </summary>
         AbiMismatch,
 
-        /*!\brief Algorithm does not have required capability */
+        /// <summary>
+        /// Algorithm does not have required capability
+        /// </summary>
         Incapable,
 
-        /*!\brief The given bitstream is not supported.
-         *
-         * The bitstream was unable to be parsed at the highest level. The decoder
-         * is unable to proceed. This error \ref SHOULD be treated as fatal to the
-         * stream. */
+        /// <summary>
+        /// The given bitstream is not supported.
+        /// </summary>
+        /// <remarks>
+        /// The bitstream was unable to be parsed at the highest level.<br/>
+        /// The decoder is unable to proceed.<br/>
+        /// This error SHOULD be treated as fatal to the stream.
+        /// </remarks>
         UnsupBitstream,
 
-        /*!\brief Encoded bitstream uses an unsupported feature
-         *
-         * The decoder does not implement a feature required by the encoder. This
-         * return code should only be used for features that prevent future
-         * pictures from being properly decoded. This error \ref MAY be treated as
-         * fatal to the stream or \ref MAY be treated as fatal to the current GOP.
-         */
+        /// <summary>
+        /// Encoded bitstream uses an unsupported feature
+        /// </summary>
+        /// <remarks>
+        /// The decoder does not implement a feature required by the encoder.<br/>
+        /// This return code should only be used for features that prevent future
+        /// pictures from being properly decoded.<br/>
+        /// <br/>
+        /// This error MAY be treated as fatal to the stream or MAY be treated as fatal to the current GOP.
+        /// </remarks>
         UnsupFeature,
 
-        /*!\brief The coded data for this stream is corrupt or incomplete
-         *
-         * There was a problem decoding the current frame.  This return code
-         * should only be used for failures that prevent future pictures from
-         * being properly decoded. This error \ref MAY be treated as fatal to the
-         * stream or \ref MAY be treated as fatal to the current GOP. If decoding
-         * is continued for the current GOP, artifacts may be present.
-         */
-        CorruptFrame,
+         /// <summary>
+         /// The coded data for this stream is corrupt or incomplete.
+         /// </summary>
+         /// <remarks>
+         /// There was a problem decoding the current frame.<br/>
+         /// This return code should only be used
+         /// for failures that prevent future pictures from being properly decoded.<br/>
+         /// <br/>
+         /// This error MAY be treated as fatal to the stream or MAY be treated as fatal to the current GOP.<br/>
+         /// If decoding is continued for the current GOP, artifacts may be present.
+         /// </remarks>
+         CorruptFrame,
 
-        /*!\brief An application-supplied parameter is not valid.
-         *
-         */
+        /// <summary>
+        /// An application-supplied parameter is not valid.
+        /// </summary>
         InvalidParam,
 
-        /*!\brief An iterator reached the end of list.
-         *
-         */
+        /// <summary>
+        /// An iterator reached the end of list.
+        /// </summary>
         ListEnd
     }
 }
\ No newline at end of file