Add missing 'TransferTextureND<T>.View' docs

Sergio0694 · Jul 5, 2024 · fbf6245 · fbf6245
1 parent b05a118
commit fbf6245
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture1D{T}.cs b/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture1D{T}.cs
@@ -118,7 +118,10 @@ public Memory<T> Memory
  }
  }
 
- /// <inheritdoc/>
+ /// <summary>
+ /// Gets a <see cref="Span{T}"/> representing a view over the mapped contents of the current <see cref="TransferTexture1D{T}"/> instance.
+ /// </summary>
+ /// <remarks>The returned view is only valid while the current <see cref="TransferTexture1D{T}"/> instance is not disposed.</remarks>
  public Span<T> Span
  {
  [MethodImpl(MethodImplOptions.AggressiveInlining)]

diff --git a/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture2D{T}.cs b/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture2D{T}.cs
@@ -113,7 +113,10 @@ private protected TransferTexture2D(GraphicsDevice device, int width, int height
  /// </summary>
  internal ref readonly D3D12_PLACED_SUBRESOURCE_FOOTPRINT D3D12PlacedSubresourceFootprint => ref this.d3D12PlacedSubresourceFootprint;
 
- /// <inheritdoc/>
+ /// <summary>
+ /// Gets a <see cref="TextureView2D{T}"/> representing a view over the mapped contents of the current <see cref="TransferTexture2D{T}"/> instance.
+ /// </summary>
+ /// <remarks>The returned view is only valid while the current <see cref="TransferTexture2D{T}"/> instance is not disposed.</remarks>
  public TextureView2D<T> View
  {
  [MethodImpl(MethodImplOptions.AggressiveInlining)]

diff --git a/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture3D{T}.cs b/src/ComputeSharp/Graphics/Resources/Abstract/TransferTexture3D{T}.cs
@@ -121,7 +121,10 @@ private protected TransferTexture3D(GraphicsDevice device, int width, int height
  /// </summary>
  internal ref readonly D3D12_PLACED_SUBRESOURCE_FOOTPRINT D3D12PlacedSubresourceFootprint => ref this.d3D12PlacedSubresourceFootprint;
 
- /// <inheritdoc/>
+ /// <summary>
+ /// Gets a <see cref="TextureView3D{T}"/> representing a view over the mapped contents of the current <see cref="TransferTexture3D{T}"/> instance.
+ /// </summary>
+ /// <remarks>The returned view is only valid while the current <see cref="TransferTexture3D{T}"/> instance is not disposed.</remarks>
  public TextureView3D<T> View
  {
  [MethodImpl(MethodImplOptions.AggressiveInlining)]