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 /ARMeilleure/Common | |
| parent | 951700fdd8f54fb34ffe8a3fb328a68b5bf37abe (diff) | |
A few minor documentation fixes. (#3599)
* A few minor documentation fixes.
* Removed more invalid inheritdoc instances.
Diffstat (limited to 'ARMeilleure/Common')
| -rw-r--r-- | ARMeilleure/Common/AddressTable.cs | 2 | ||||
| -rw-r--r-- | ARMeilleure/Common/Counter.cs | 6 |
2 files changed, 5 insertions, 3 deletions
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) |