Skip to content

Fix DocFX indexer comments inheritance by removing problematic include tags #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
konard wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix DocFX indexer comments inheritance by removing problematic include tags #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a913294
Initial commit with task details for issue #16
konard Sep 14, 2025
f5daa5c
Fix DocFX indexer comments inheritance by removing problematic includ…
konard Sep 14, 2025
dd5e71e
Remove CLAUDE.md - Claude command completed
konard Sep 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions csharp/Platform.Memory/ArrayMemory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,13 @@ public class ArrayMemory<TElement> : IArrayMemory<TElement>
#region Properties

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IMemory.Size"]/*'/>
public long Size
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _array.Length;
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IArrayMemory`1.Item(System.Int64)"]/*'/>
public TElement this[long index]
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
3 changes: 0 additions & 3 deletions csharp/Platform.Memory/DirectMemoryAsArrayMemoryAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,20 @@ public class DirectMemoryAsArrayMemoryAdapter<TElement> : DisposableBase, IArray
#region Properties

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IMemory.Size"]/*'/>
public long Size
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _memory.Size;
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IDirectMemory.Pointer"]/*'/>
public IntPtr Pointer
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _memory.Pointer;
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IArrayMemory`1.Item(System.Int64)"]/*'/>
public TElement this[long index]
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
2 changes: 0 additions & 2 deletions csharp/Platform.Memory/FileArrayMemory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ public class FileArrayMemory<TElement> : DisposableBase, IArrayMemory<TElement>
#region Properties

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IMemory.Size"]/*'/>
public long Size
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _file.Length;
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IArrayMemory`1.Item(System.Int64)"]/*'/>
public TElement this[long index]
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
2 changes: 0 additions & 2 deletions csharp/Platform.Memory/FileMappedResizableDirectMemory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ private bool UnmapFile(IntPtr pointer)
#region ResizableDirectMemoryBase Methods

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="M:Platform.Memory.ResizableDirectMemoryBase.OnReservedCapacityChanged(System.Int64,System.Int64)"]/*'/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void OnReservedCapacityChanged(long oldReservedCapacity, long newReservedCapacity)
{
Expand All @@ -123,7 +122,6 @@ protected override void OnReservedCapacityChanged(long oldReservedCapacity, long
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="M:Platform.Memory.ResizableDirectMemoryBase.DisposePointer(System.IntPtr,System.Int64)"]/*'/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void DisposePointer(IntPtr pointer, long usedCapacity)
{
Expand Down
2 changes: 0 additions & 2 deletions csharp/Platform.Memory/HeapResizableDirectMemory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,10 @@ public HeapResizableDirectMemory() : this(MinimumCapacity) { }
#region ResizableDirectMemoryBase Methods

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="M:Platform.Memory.ResizableDirectMemoryBase.DisposePointer(System.IntPtr,System.Int64)"]/*'/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void DisposePointer(IntPtr pointer, long usedCapacity) => Marshal.FreeHGlobal(pointer);

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="M:Platform.Memory.ResizableDirectMemoryBase.OnReservedCapacityChanged(System.Int64,System.Int64)"]/*'/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void OnReservedCapacityChanged(long oldReservedCapacity, long newReservedCapacity)
{
Expand Down
4 changes: 0 additions & 4 deletions csharp/Platform.Memory/ResizableDirectMemoryBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ public abstract class ResizableDirectMemoryBase : DisposableBase, IResizableDire
#region Properties

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IMemory.Size"]/*'/>
/// <exception cref="ObjectDisposedException"><para>The memory block is disposed.</para><para>Блок памяти уже высвобожден.</para></exception>
public long Size
{
Expand All @@ -46,7 +45,6 @@ public long Size
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IDirectMemory.Pointer"]/*'/>
/// <exception cref="ObjectDisposedException"><para>The memory block is disposed.</para><para>Блок памяти уже высвобожден.</para></exception>
public IntPtr Pointer
{
Expand All @@ -65,7 +63,6 @@ protected set
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IResizableDirectMemory.ReservedCapacity"]/*'/>
/// <exception cref="ObjectDisposedException"><para>The memory block is disposed.</para><para>Блок памяти уже высвобожден.</para></exception>
/// <exception cref="ArgumentOutOfRangeException"><para>Attempted to set the reserved capacity to a value that is less than the used capacity.</para><para>Была выполнена попытка установить зарезервированную емкость на значение, которое меньше используемой емкости.</para></exception>
public long ReservedCapacity
Expand All @@ -90,7 +87,6 @@ public long ReservedCapacity
}

/// <inheritdoc/>
/// <include file='bin\Release\netstandard2.0\Platform.Memory.xml' path='doc/members/member[@name="P:Platform.Memory.IResizableDirectMemory.UsedCapacity"]/*'/>
/// <exception cref="ObjectDisposedException"><para>The memory block is disposed.</para><para>Блок памяти уже высвобожден.</para></exception>
/// <exception cref="ArgumentOutOfRangeException"><para>Attempted to set the used capacity to a value that is greater than the reserved capacity or less than zero.</para><para>Была выполнена попытка установить используемую емкость на значение, которое больше, чем зарезервированная емкость или меньше нуля.</para></exception>
public long UsedCapacity
Expand Down
Loading