Added comments and annotations

This commit is contained in:
ForeverZer0 2021-08-25 05:21:56 -04:00
parent 8b3bc44710
commit 6ddd8c8322
1 changed files with 4 additions and 2 deletions

View File

@ -1,12 +1,14 @@
using System; using System;
using System.Runtime.CompilerServices; using System.Runtime.CompilerServices;
using JetBrains.Annotations;
namespace SharpNBT.ZLib namespace SharpNBT.ZLib
{ {
/// <summary> /// <summary>
/// An Adler-32 checksum implementation for ZLib streams. /// An Adler-32 checksum implementation for ZLib streams.
/// </summary> /// </summary>
/// <seealso href=""/> /// <seealso href="https://en.wikipedia.org/wiki/Adler-32"/>
[PublicAPI]
public sealed class Adler32 public sealed class Adler32
{ {
private uint a = 1; private uint a = 1;
@ -89,7 +91,7 @@ namespace SharpNBT.ZLib
} }
/// <summary> /// <summary>
/// Gets the current calculated checksum value as an unsigned 32-bit integer. /// Gets the current calculated checksum value as the original unsigned 32-bit integer value.
/// </summary> /// </summary>
[CLSCompliant(false)] [CLSCompliant(false)]
public uint UnsignedValue public uint UnsignedValue