Skip to content

Commit 58bbc54

Browse files
#244 Update documentations
1 parent b9f4112 commit 58bbc54

5 files changed

Lines changed: 13 additions & 13 deletions

File tree

src/ImageSharp/Formats/Png/PngEncoderCore.cs

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,32 +85,32 @@ internal sealed class PngEncoderCore : IDisposable
8585
private int height;
8686

8787
/// <summary>
88-
/// The previous scanline.
88+
/// The raw data of previous scanline.
8989
/// </summary>
9090
private IManagedByteBuffer previousScanline;
9191

9292
/// <summary>
93-
/// The raw scanline.
93+
/// The raw data of current scanline.
9494
/// </summary>
9595
private IManagedByteBuffer currentScanline;
9696

9797
/// <summary>
98-
/// The common buffer for the filters
98+
/// The common buffer for the filters.
9999
/// </summary>
100100
private IManagedByteBuffer filterBuffer;
101101

102102
/// <summary>
103-
/// The buffer for the sub filter
103+
/// The ext buffer for the sub filter, <see cref="PngFilterMethod.Adaptive"/>.
104104
/// </summary>
105105
private IManagedByteBuffer subFilter;
106106

107107
/// <summary>
108-
/// The buffer for the average filter
108+
/// The ext buffer for the average filter, <see cref="PngFilterMethod.Adaptive"/>.
109109
/// </summary>
110110
private IManagedByteBuffer averageFilter;
111111

112112
/// <summary>
113-
/// The buffer for the Paeth filter
113+
/// The ext buffer for the Paeth filter, <see cref="PngFilterMethod.Adaptive"/>.
114114
/// </summary>
115115
private IManagedByteBuffer paethFilter;
116116

@@ -390,7 +390,7 @@ private void CollectPixelBytes<TPixel>(ReadOnlySpan<TPixel> rowSpan, IQuantizedF
390390
}
391391

392392
/// <summary>
393-
/// Apply filter for the pixel bytes.
393+
/// Apply filter for the raw scanline.
394394
/// </summary>
395395
private IManagedByteBuffer FilterPixelBytes()
396396
{
@@ -780,9 +780,7 @@ private void AllocateExtBuffers()
780780
int resultLength = this.filterBuffer.Length();
781781

782782
this.subFilter = this.memoryAllocator.AllocateManagedByteBuffer(resultLength, AllocationOptions.Clean);
783-
784783
this.averageFilter = this.memoryAllocator.AllocateManagedByteBuffer(resultLength, AllocationOptions.Clean);
785-
786784
this.paethFilter = this.memoryAllocator.AllocateManagedByteBuffer(resultLength, AllocationOptions.Clean);
787785
}
788786
}

src/ImageSharp/Formats/Png/PngEncoderHelpers.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77

88
namespace SixLabors.ImageSharp.Formats.Png
99
{
10+
/// <summary>
11+
/// The helper methods for <see cref="PngEncoderCore"/> class.
12+
/// </summary>
1013
internal static class PngEncoderHelpers
1114
{
1215
/// <summary>

src/ImageSharp/Formats/Png/PngEncoderOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace SixLabors.ImageSharp.Formats.Png
77
{
88
/// <summary>
9-
/// The <see cref="PngEncoderCore"/> options class.
9+
/// The options structure for the <see cref="PngEncoderCore"/>.
1010
/// </summary>
1111
/// <seealso cref="SixLabors.ImageSharp.Formats.Png.IPngEncoderOptions" />
1212
internal class PngEncoderOptions : IPngEncoderOptions

src/ImageSharp/Formats/Png/PngEncoderOptionsHelpers.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
namespace SixLabors.ImageSharp.Formats.Png
1010
{
1111
/// <summary>
12-
/// The PNG encoder options helper methods class.
12+
/// The helper methods for the PNG encoder options.
1313
/// </summary>
1414
internal static class PngEncoderOptionsHelpers
1515
{

tests/ImageSharp.Tests/Formats/Png/PngEncoderTests.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
// Licensed under the Apache License, Version 2.0.
33

44
// ReSharper disable InconsistentNaming
5-
using System.Diagnostics;
65
using System.IO;
76
using System.Linq;
87

@@ -134,7 +133,7 @@ public void WorksWithAllFilterMethods<TPixel>(TestImageProvider<TPixel> provider
134133
where TPixel : struct, IPixel<TPixel>
135134
{
136135
foreach (PngInterlaceMode interlaceMode in InterlaceMode)
137-
{
136+
{
138137
TestPngEncoderCore(
139138
provider,
140139
PngColorType.RgbWithAlpha,

0 commit comments

Comments
 (0)