diff --git a/docfx/docfx.json b/docfx/docfx.json
index b38e0b9e4..271763230 100644
--- a/docfx/docfx.json
+++ b/docfx/docfx.json
@@ -11,7 +11,10 @@
}
],
"outputFormat": "apiPage",
- "output": "api"
+ "output": "api",
+ "properties": {
+ "TargetFramework": "net8.0"
+ }
}
],
"build": {
diff --git a/src/Renci.SshNet/Compression/Compressor.cs b/src/Renci.SshNet/Compression/Compressor.cs
index 876144962..9c643c921 100644
--- a/src/Renci.SshNet/Compression/Compressor.cs
+++ b/src/Renci.SshNet/Compression/Compressor.cs
@@ -21,8 +21,8 @@ public abstract class Compressor : Algorithm, IDisposable
///
///
/// to start compression after receiving SSH_MSG_NEWKEYS.
- /// to delay compression util receiving SSH_MSG_USERAUTH_SUCCESS.
- /// .
+ /// to delay compression until SSH_MSG_USERAUTH_SUCCESS is received.
+ /// See .
///
protected Compressor(bool delayedCompression)
{
diff --git a/src/Renci.SshNet/Compression/Zlib.cs b/src/Renci.SshNet/Compression/Zlib.cs
index 29fe8aacb..f7da2eb15 100644
--- a/src/Renci.SshNet/Compression/Zlib.cs
+++ b/src/Renci.SshNet/Compression/Zlib.cs
@@ -5,9 +5,9 @@
namespace Renci.SshNet.Compression
{
///
- /// Represents "zlib" compression implementation.
+ /// Represents the "zlib" compression algorithm.
///
- internal class Zlib : Compressor
+ public class Zlib : Compressor
{
private readonly ZLibStream _compressor;
private readonly ZLibStream _decompressor;
@@ -15,11 +15,20 @@ internal class Zlib : Compressor
private MemoryStream _decompressorStream;
private bool _isDisposed;
+ ///
+ /// Initializes a new instance of the class.
+ ///
public Zlib()
: this(delayedCompression: false)
{
}
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ ///
+ ///
+ ///
protected Zlib(bool delayedCompression)
: base(delayedCompression)
{
@@ -30,14 +39,13 @@ protected Zlib(bool delayedCompression)
_decompressor = new ZLibStream(_decompressorStream, CompressionMode.Decompress);
}
- ///
- /// Gets algorithm name.
- ///
+ ///
public override string Name
{
get { return "zlib"; }
}
+ ///
protected override byte[] CompressCore(byte[] data, int offset, int length)
{
_compressorStream.SetLength(0);
@@ -48,6 +56,7 @@ protected override byte[] CompressCore(byte[] data, int offset, int length)
return _compressorStream.ToArray();
}
+ ///
protected override byte[] DecompressCore(byte[] data, int offset, int length)
{
_decompressorStream.Write(data, offset, length);
diff --git a/src/Renci.SshNet/Compression/ZlibOpenSsh.cs b/src/Renci.SshNet/Compression/ZlibOpenSsh.cs
index 6ece09254..02bea40bc 100644
--- a/src/Renci.SshNet/Compression/ZlibOpenSsh.cs
+++ b/src/Renci.SshNet/Compression/ZlibOpenSsh.cs
@@ -1,13 +1,20 @@
#if NET6_0_OR_GREATER
namespace Renci.SshNet.Compression
{
- internal sealed class ZlibOpenSsh : Zlib
+ ///
+ /// Represents the "zlib@openssh.com" compression algorithm.
+ ///
+ public class ZlibOpenSsh : Zlib
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public ZlibOpenSsh()
: base(delayedCompression: true)
{
}
+ ///
public override string Name
{
get { return "zlib@openssh.com"; }
diff --git a/src/Renci.SshNet/Security/Algorithm.cs b/src/Renci.SshNet/Security/Algorithm.cs
index 180c9d024..30f2dae54 100644
--- a/src/Renci.SshNet/Security/Algorithm.cs
+++ b/src/Renci.SshNet/Security/Algorithm.cs
@@ -6,7 +6,7 @@
public abstract class Algorithm
{
///
- /// Gets algorithm name.
+ /// Gets the algorithm name.
///
public abstract string Name { get; }
}