diff options
| author | Nicholas Rodine <halfofastaple@gmail.com> | 2022-08-19 16:21:06 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-19 18:21:06 -0300 |
| commit | 7defc59b9dee5459e52f394642643dbd59c9b32f (patch) | |
| tree | 37ee761db4901868a8b33ac47cb1571ce70618ab | |
| parent | 951700fdd8f54fb34ffe8a3fb328a68b5bf37abe (diff) | |
A few minor documentation fixes. (#3599)1.1.224
* A few minor documentation fixes.
* Removed more invalid inheritdoc instances.
| -rw-r--r-- | ARMeilleure/CodeGen/Linking/Symbol.cs | 1 | ||||
| -rw-r--r-- | ARMeilleure/Common/AddressTable.cs | 2 | ||||
| -rw-r--r-- | ARMeilleure/Common/Counter.cs | 6 | ||||
| -rw-r--r-- | ARMeilleure/Translation/IntervalTree.cs | 2 | ||||
| -rw-r--r-- | Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs | 15 |
5 files changed, 6 insertions, 20 deletions
diff --git a/ARMeilleure/CodeGen/Linking/Symbol.cs b/ARMeilleure/CodeGen/Linking/Symbol.cs index fa47ee23..39e0c3eb 100644 --- a/ARMeilleure/CodeGen/Linking/Symbol.cs +++ b/ARMeilleure/CodeGen/Linking/Symbol.cs @@ -58,7 +58,6 @@ namespace ARMeilleure.CodeGen.Linking /// <param name="a">First instance</param> /// <param name="b">Second instance</param> /// <returns><see langword="true"/> if not equal; otherwise <see langword="false"/></returns> - /// <inheritdoc/> public static bool operator !=(Symbol a, Symbol b) { return !(a == b); diff --git a/ARMeilleure/Common/AddressTable.cs b/ARMeilleure/Common/AddressTable.cs index 60586a35..e03a38e6 100644 --- a/ARMeilleure/Common/AddressTable.cs +++ b/ARMeilleure/Common/AddressTable.cs @@ -206,7 +206,7 @@ namespace ARMeilleure.Common /// <typeparam name="T">Type of elements</typeparam> /// <param name="length">Number of elements</param> /// <param name="fill">Fill value</param> - /// <param name="leaf"><see langword="true"/> if leaf; otherwise <see langword=""="false"/></param> + /// <param name="leaf"><see langword="true"/> if leaf; otherwise <see langword="false"/></param> /// <returns>Allocated block</returns> private IntPtr Allocate<T>(int length, T fill, bool leaf) where T : unmanaged { diff --git a/ARMeilleure/Common/Counter.cs b/ARMeilleure/Common/Counter.cs index defb5aba..4b0627c1 100644 --- a/ARMeilleure/Common/Counter.cs +++ b/ARMeilleure/Common/Counter.cs @@ -9,6 +9,9 @@ namespace ARMeilleure.Common class Counter<T> : IDisposable where T : unmanaged { private bool _disposed; + /// <summary> + /// Index in the <see cref="EntryTable{T}"/> + /// </summary> private readonly int _index; private readonly EntryTable<T> _countTable; @@ -17,7 +20,6 @@ namespace ARMeilleure.Common /// <see cref="EntryTable{T}"/> instance and index. /// </summary> /// <param name="countTable"><see cref="EntryTable{T}"/> instance</param> - /// <param name="index">Index in the <see cref="EntryTable{T}"/></param> /// <exception cref="ArgumentNullException"><paramref name="countTable"/> is <see langword="null"/></exception> /// <exception cref="ArgumentException"><typeparamref name="T"/> is unsupported</exception> public Counter(EntryTable<T> countTable) @@ -68,7 +70,7 @@ namespace ARMeilleure.Common /// <summary> /// Releases all unmanaged and optionally managed resources used by the <see cref="Counter{T}"/> instance. /// </summary> - /// <param name="disposing"><see langword="true"/> to dispose managed resources also; otherwise just unmanaged resouces</param> + /// <param name="disposing"><see langword="true"/> to dispose managed resources also; otherwise just unmanaged resources</param> protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/ARMeilleure/Translation/IntervalTree.cs b/ARMeilleure/Translation/IntervalTree.cs index 51b9a51f..10bab7ae 100644 --- a/ARMeilleure/Translation/IntervalTree.cs +++ b/ARMeilleure/Translation/IntervalTree.cs @@ -344,7 +344,7 @@ namespace ARMeilleure.Translation } /// <summary> - /// Removes the value from the dictionary after searching for it with <paramref name="key">. + /// Removes the value from the dictionary after searching for it with <paramref name="key"/>. /// </summary> /// <param name="key">Key to search for</param> /// <returns>Number of deleted values</returns> diff --git a/Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs b/Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs index 7243f643..a0c779b5 100644 --- a/Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs +++ b/Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs @@ -27,7 +27,6 @@ namespace Ryujinx.Graphics.Gpu.Shader _stageIndex = stageIndex; } - /// <inheritdoc/> public int QueryBindingConstantBuffer(int index) { if (_context.Capabilities.Api == TargetApi.Vulkan) @@ -41,7 +40,6 @@ namespace Ryujinx.Graphics.Gpu.Shader } } - /// <inheritdoc/> public int QueryBindingStorageBuffer(int index) { if (_context.Capabilities.Api == TargetApi.Vulkan) @@ -54,7 +52,6 @@ namespace Ryujinx.Graphics.Gpu.Shader } } - /// <inheritdoc/> public int QueryBindingTexture(int index, bool isBuffer) { if (_context.Capabilities.Api == TargetApi.Vulkan) @@ -72,7 +69,6 @@ namespace Ryujinx.Graphics.Gpu.Shader } } - /// <inheritdoc/> public int QueryBindingImage(int index, bool isBuffer) { if (_context.Capabilities.Api == TargetApi.Vulkan) @@ -116,37 +112,26 @@ namespace Ryujinx.Graphics.Gpu.Shader }; } - /// <inheritdoc/> public bool QueryHostHasFrontFacingBug() => _context.Capabilities.HasFrontFacingBug; - /// <inheritdoc/> public bool QueryHostHasVectorIndexingBug() => _context.Capabilities.HasVectorIndexingBug; - /// <inheritdoc/> public int QueryHostStorageBufferOffsetAlignment() => _context.Capabilities.StorageBufferOffsetAlignment; - /// <inheritdoc/> public bool QueryHostSupportsBgraFormat() => _context.Capabilities.SupportsBgraFormat; - /// <inheritdoc/> public bool QueryHostSupportsFragmentShaderInterlock() => _context.Capabilities.SupportsFragmentShaderInterlock; - /// <inheritdoc/> public bool QueryHostSupportsFragmentShaderOrderingIntel() => _context.Capabilities.SupportsFragmentShaderOrderingIntel; - /// <inheritdoc/> public bool QueryHostSupportsGeometryShaderPassthrough() => _context.Capabilities.SupportsGeometryShaderPassthrough; - /// <inheritdoc/> public bool QueryHostSupportsImageLoadFormatted() => _context.Capabilities.SupportsImageLoadFormatted; - /// <inheritdoc/> public bool QueryHostSupportsNonConstantTextureOffset() => _context.Capabilities.SupportsNonConstantTextureOffset; - /// <inheritdoc/> public bool QueryHostSupportsShaderBallot() => _context.Capabilities.SupportsShaderBallot; - /// <inheritdoc/> public bool QueryHostSupportsTextureShadowLod() => _context.Capabilities.SupportsTextureShadowLod; /// <summary> |