PR #477: Fix spelling errors in comments

Numpsy · web-flow · commit b5898dc3067c · 2020-07-04T18:24:25.000+02:00
diff --git a/src/ICSharpCode.SharpZipLib/Checksum/BZip2Crc.cs b/src/ICSharpCode.SharpZipLib/Checksum/BZip2Crc.cs
@@ -134,7 +134,7 @@ public long Value
 		{
 			get
 			{
-				// Tehcnically, the output should be:
+				// Technically, the output should be:
 				//return (long)(~checkValue ^ crcXor);
 				// but x ^ 0 = x, so there is no point in adding
 				// the XOR operation
diff --git a/src/ICSharpCode.SharpZipLib/Core/FileSystemScanner.cs b/src/ICSharpCode.SharpZipLib/Core/FileSystemScanner.cs
@@ -78,7 +78,7 @@ public string Name
 		}
 
 		/// <summary>
-		/// Get set a value indicating wether scanning should continue or not.
+		/// Get set a value indicating whether scanning should continue or not.
 		/// </summary>
 		public bool ContinueRunning
 		{
@@ -209,7 +209,7 @@ public Exception Exception
 		}
 
 		/// <summary>
-		/// Get / set a value indicating wether scanning should continue.
+		/// Get / set a value indicating whether scanning should continue.
 		/// </summary>
 		public bool ContinueRunning
 		{
diff --git a/src/ICSharpCode.SharpZipLib/Lzw/LzwInputStream.cs b/src/ICSharpCode.SharpZipLib/Lzw/LzwInputStream.cs
@@ -485,7 +485,7 @@ public override void SetLength(long value)
 		/// Writes a sequence of bytes to stream and advances the current position
 		/// This method always throws a NotSupportedException
 		/// </summary>
-		/// <param name="buffer">Thew buffer containing data to write.</param>
+		/// <param name="buffer">The buffer containing data to write.</param>
 		/// <param name="offset">The offset of the first byte to write.</param>
 		/// <param name="count">The number of bytes to write.</param>
 		/// <exception cref="NotSupportedException">Any access</exception>
diff --git a/src/ICSharpCode.SharpZipLib/Tar/TarArchive.cs b/src/ICSharpCode.SharpZipLib/Tar/TarArchive.cs
@@ -61,7 +61,7 @@ protected TarArchive()
 		}
 
 		/// <summary>
-		/// Initalise a TarArchive for input.
+		/// Initialise a TarArchive for input.
 		/// </summary>
 		/// <param name="stream">The <see cref="TarInputStream"/> to use for input.</param>
 		protected TarArchive(TarInputStream stream)
diff --git a/src/ICSharpCode.SharpZipLib/Tar/TarOutputStream.cs b/src/ICSharpCode.SharpZipLib/Tar/TarOutputStream.cs
@@ -187,7 +187,7 @@ public override int ReadByte()
 		/// <param name="count">The desired number of bytes to read.</param>
 		/// <returns>The total number of bytes read, or zero if at the end of the stream.
 		/// The number of bytes may be less than the <paramref name="count">count</paramref>
-		/// requested if data is not avialable.</returns>
+		/// requested if data is not available.</returns>
 		public override int Read(byte[] buffer, int offset, int count)
 		{
 			return outputStream.Read(buffer, offset, count);
@@ -250,7 +250,7 @@ public int GetRecordSize()
 		}
 
 		/// <summary>
-		/// Get a value indicating wether an entry is open, requiring more data to be written.
+		/// Get a value indicating whether an entry is open, requiring more data to be written.
 		/// </summary>
 		private bool IsEntryOpen
 		{
@@ -483,7 +483,7 @@ private void WriteEofBlock()
 		private int assemblyBufferLength;
 
 		/// <summary>
-		/// Flag indicating wether this instance has been closed or not.
+		/// Flag indicating whether this instance has been closed or not.
 		/// </summary>
 		private bool isClosed;
 
diff --git a/src/ICSharpCode.SharpZipLib/Zip/Compression/DeflaterEngine.cs b/src/ICSharpCode.SharpZipLib/Zip/Compression/DeflaterEngine.cs
@@ -56,7 +56,7 @@ public class DeflaterEngine
 
 		/// <summary>
 		/// Construct instance with pending buffer
-		/// Adler calculation will be peformed
+		/// Adler calculation will be performed
 		/// </summary>
 		/// <param name="pending">
 		/// Pending buffer to use
diff --git a/src/ICSharpCode.SharpZipLib/Zip/Compression/Streams/InflaterInputStream.cs b/src/ICSharpCode.SharpZipLib/Zip/Compression/Streams/InflaterInputStream.cs
@@ -596,7 +596,7 @@ public override void SetLength(long value)
 		/// Writes a sequence of bytes to stream and advances the current position
 		/// This method always throws a NotSupportedException
 		/// </summary>
-		/// <param name="buffer">Thew buffer containing data to write.</param>
+		/// <param name="buffer">The buffer containing data to write.</param>
 		/// <param name="offset">The offset of the first byte to write.</param>
 		/// <param name="count">The number of bytes to write.</param>
 		/// <exception cref="NotSupportedException">Any access</exception>
@@ -704,7 +704,7 @@ public override int Read(byte[] buffer, int offset, int count)
 		protected long csize;
 
 		/// <summary>
-		/// Flag indicating wether this instance has been closed or not.
+		/// Flag indicating whether this instance has been closed or not.
 		/// </summary>
 		private bool isClosed;
 
diff --git a/src/ICSharpCode.SharpZipLib/Zip/FastZip.cs b/src/ICSharpCode.SharpZipLib/Zip/FastZip.cs
@@ -209,7 +209,7 @@ public FastZip(FastZipEvents events)
 		#region Properties
 
 		/// <summary>
-		/// Get/set a value indicating wether empty directories should be created.
+		/// Get/set a value indicating whether empty directories should be created.
 		/// </summary>
 		public bool CreateEmptyDirectories
 		{
@@ -267,7 +267,7 @@ public IEntryFactory EntryFactory
 		/// read Zip64 archives. However it does avoid the situation were a large file
 		/// is added and cannot be completed correctly.
 		/// NOTE: Setting the size for entries before they are added is the best solution!
-		/// By default the EntryFactory used by FastZip will set fhe file size.
+		/// By default the EntryFactory used by FastZip will set the file size.
 		/// </remarks>
 		public UseZip64 UseZip64
 		{
@@ -276,7 +276,7 @@ public UseZip64 UseZip64
 		}
 
 		/// <summary>
-		/// Get/set a value indicating wether file dates and times should
+		/// Get/set a value indicating whether file dates and times should
 		/// be restored when extracting files from an archive.
 		/// </summary>
 		/// <remarks>The default value is false.</remarks>
@@ -533,7 +533,7 @@ private void ProcessFile(object sender, ScanEventArgs e)
 			{
 				try
 				{
-					// The open below is equivalent to OpenRead which gaurantees that if opened the
+					// The open below is equivalent to OpenRead which guarantees that if opened the
 					// file will not be changed by subsequent openers, but precludes opening in some cases
 					// were it could succeed. ie the open may fail as its already open for writing and the share mode should reflect that.
 					using (FileStream stream = File.Open(e.Name, FileMode.Open, FileAccess.Read, FileShare.Read))
diff --git a/src/ICSharpCode.SharpZipLib/Zip/WindowsNameTransform.cs b/src/ICSharpCode.SharpZipLib/Zip/WindowsNameTransform.cs
@@ -81,7 +81,7 @@ public bool AllowParentTraversal
 		}
 
 		/// <summary>
-		/// Gets or sets a value indicating wether paths on incoming values should be removed.
+		/// Gets or sets a value indicating whether paths on incoming values should be removed.
 		/// </summary>
 		public bool TrimIncomingPaths
 		{
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipConstants.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipConstants.cs
@@ -161,7 +161,7 @@ public enum GeneralBitFlags
 		Method = 0x0006,
 
 		/// <summary>
-		/// Bit 3 if set indicates a trailing data desciptor is appended to the entry data
+		/// Bit 3 if set indicates a trailing data descriptor is appended to the entry data
 		/// </summary>
 		Descriptor = 0x0008,
 
@@ -443,12 +443,12 @@ public static class ZipConstants
 		public const int ArchiveExtraDataSignature = 'P' | ('K' << 8) | (6 << 16) | (7 << 24);
 
 		/// <summary>
-		/// Central header digitial signature
+		/// Central header digital signature
 		/// </summary>
 		public const int CentralHeaderDigitalSignature = 'P' | ('K' << 8) | (5 << 16) | (5 << 24);
 
 		/// <summary>
-		/// Central header digitial signature
+		/// Central header digital signature
 		/// </summary>
 		[Obsolete("Use CentralHeaderDigitalSignaure instead")]
 		public const int CENDIGITALSIG = 'P' | ('K' << 8) | (5 << 16) | (5 << 24);
@@ -468,7 +468,7 @@ public static class ZipConstants
 
 		/// <summary>
 		/// Default encoding used for string conversion.  0 gives the default system OEM code page.
-		/// Using the default code page isnt the full solution neccessarily
+		/// Using the default code page isnt the full solution necessarily
 		/// there are many variable factors, codepage 850 is often a good choice for
 		/// European users, however be careful about compatability.
 		/// </summary>
@@ -479,32 +479,32 @@ public static int DefaultCodePage
 			set => ZipStrings.CodePage = value;
 		}
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToString(byte[], int)"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToString(byte[], int)"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToString instead")]
 		public static string ConvertToString(byte[] data, int count)
 			=> ZipStrings.ConvertToString(data, count);
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToString(byte[])"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToString(byte[])"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToString instead")]
 		public static string ConvertToString(byte[] data)
 			=> ZipStrings.ConvertToString(data);
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[], int)"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[], int)"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToStringExt instead")]
 		public static string ConvertToStringExt(int flags, byte[] data, int count)
 			=> ZipStrings.ConvertToStringExt(flags, data, count);
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[])"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[])"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToStringExt instead")]
 		public static string ConvertToStringExt(int flags, byte[] data)
 			=> ZipStrings.ConvertToStringExt(flags, data);
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToArray(string)"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToArray(string)"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToArray instead")]
 		public static byte[] ConvertToArray(string str)
 			=> ZipStrings.ConvertToArray(str);
 
-		/// <summary> Depracated wrapper for <see cref="ZipStrings.ConvertToArray(int, string)"/></summary>
+		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToArray(int, string)"/></summary>
 		[Obsolete("Use ZipStrings.ConvertToArray instead")]
 		public static byte[] ConvertToArray(int flags, string str)
 			=> ZipStrings.ConvertToArray(flags, str);
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipEntry.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipEntry.cs
@@ -261,7 +261,7 @@ public ZipEntry(ZipEntry entry)
 		#endregion Constructors
 
 		/// <summary>
-		/// Get a value indicating wether the entry has a CRC value available.
+		/// Get a value indicating whether the entry has a CRC value available.
 		/// </summary>
 		public bool HasCrc
 		{
@@ -296,7 +296,7 @@ public bool IsCrypted
 		}
 
 		/// <summary>
-		/// Get / set a flag indicating wether entry name and comment text are
+		/// Get / set a flag indicating whether entry name and comment text are
 		/// encoded in <a href="http://www.unicode.org">unicode UTF8</a>.
 		/// </summary>
 		/// <remarks>This is an assistant that interprets the <see cref="Flags">flags</see> property.</remarks>
@@ -606,7 +606,7 @@ public int Version
 		/// Get a value indicating whether this entry can be decompressed by the library.
 		/// </summary>
 		/// <remarks>This is based on the <see cref="Version"></see> and
-		/// wether the <see cref="IsCompressionMethodSupported()">compression method</see> is supported.</remarks>
+		/// whether the <see cref="IsCompressionMethodSupported()">compression method</see> is supported.</remarks>
 		public bool CanDecompress
 		{
 			get
@@ -630,7 +630,7 @@ public void ForceZip64()
 		}
 
 		/// <summary>
-		/// Get a value indicating wether Zip64 extensions were forced.
+		/// Get a value indicating whether Zip64 extensions were forced.
 		/// </summary>
 		/// <returns>A <see cref="bool"/> value of true if Zip64 extensions have been forced on; false if not.</returns>
 		public bool IsZip64Forced()
@@ -670,7 +670,7 @@ public bool LocalHeaderRequiresZip64
 		}
 
 		/// <summary>
-		/// Get a value indicating wether the central directory entry requires Zip64 extensions to be stored.
+		/// Get a value indicating whether the central directory entry requires Zip64 extensions to be stored.
 		/// </summary>
 		public bool CentralHeaderRequiresZip64
 		{
@@ -901,7 +901,7 @@ public byte[] ExtraData
 		{
 			get
 			{
-				// TODO: This is slightly safer but less efficient.  Think about wether it should change.
+				// TODO: This is slightly safer but less efficient.  Think about whether it should change.
 				//				return (byte[]) extra.Clone();
 				return extra;
 			}
@@ -1059,7 +1059,7 @@ internal void ProcessExtraData(bool localHeader)
 				//		flag 13 is set indicating masking, the value stored for the
 				//		uncompressed size in the Local Header will be zero.
 				//
-				// Othewise there is problem with minizip implementation
+				// Otherwise there is problem with minizip implementation
 				if (size == uint.MaxValue)
 				{
 					size = (ulong)extraData.ReadLong();
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipEntryFactory.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipEntryFactory.cs
@@ -162,7 +162,7 @@ public int SetAttributes
 		}
 
 		/// <summary>
-		/// Get set a value indicating wether unidoce text should be set on.
+		/// Get set a value indicating whether unidoce text should be set on.
 		/// </summary>
 		public bool IsUnicodeText
 		{
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipExtraData.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipExtraData.cs
@@ -3,7 +3,7 @@
 
 namespace ICSharpCode.SharpZipLib.Zip
 {
-	// TODO: Sort out wether tagged data is useful and what a good implementation might look like.
+	// TODO: Sort out whether tagged data is useful and what a good implementation might look like.
 	// Its just a sketch of an idea at the moment.
 
 	/// <summary>
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipFile.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipFile.cs
@@ -191,7 +191,7 @@ public long BytesTested
 		}
 
 		/// <summary>
-		/// Get a value indicating wether the last entry test was valid.
+		/// Get a value indicating whether the last entry test was valid.
 		/// </summary>
 		public bool EntryValid
 		{
@@ -318,7 +318,7 @@ public class ZipFile : IEnumerable, IDisposable
 		#region KeyHandling
 
 		/// <summary>
-		/// Delegate for handling keys/password setting during compresion/decompression.
+		/// Delegate for handling keys/password setting during compression/decompression.
 		/// </summary>
 		public delegate void KeysRequiredEventHandler(
 			object sender,
@@ -375,7 +375,7 @@ public string Password
 		}
 
 		/// <summary>
-		/// Get a value indicating wether encryption keys are currently available.
+		/// Get a value indicating whether encryption keys are currently available.
 		/// </summary>
 		private bool HaveKeys
 		{
@@ -654,7 +654,7 @@ public bool IsStreamOwner
 		}
 
 		/// <summary>
-		/// Get a value indicating wether
+		/// Get a value indicating whether
 		/// this archive is embedded in another file or not.
 		/// </summary>
 		public bool IsEmbeddedArchive
@@ -2094,7 +2094,7 @@ private void WriteLocalEntryHeader(ZipUpdate update)
 						break;
 
 					case UseZip64.Off:
-						// Do nothing.  The entry itself may be using Zip64 independantly.
+						// Do nothing.  The entry itself may be using Zip64 independently.
 						break;
 				}
 			}
@@ -3395,7 +3395,7 @@ private void ReadEntries()
 			//
 			// The search is limited to 64K which is the maximum size of a trailing comment field to aid speed.
 			// This should be compatible with both SFX and ZIP files but has only been tested for Zip files
-			// If a SFX file has the Zip data attached as a resource and there are other resources occuring later then
+			// If a SFX file has the Zip data attached as a resource and there are other resources occurring later then
 			// this could be invalid.
 			// Could also speed this up by reading memory in larger blocks.
 
@@ -4381,7 +4381,7 @@ public interface IDynamicDataSource
 	public class StaticDiskDataSource : IStaticDataSource
 	{
 		/// <summary>
-		/// Initialise a new instnace of <see cref="StaticDiskDataSource"/>
+		/// Initialise a new instance of <see cref="StaticDiskDataSource"/>
 		/// </summary>
 		/// <param name="fileName">The name of the file to obtain data from.</param>
 		public StaticDiskDataSource(string fileName)
@@ -4394,7 +4394,7 @@ public StaticDiskDataSource(string fileName)
 		/// <summary>
 		/// Get a <see cref="Stream"/> providing data.
 		/// </summary>
-		/// <returns>Returns a <see cref="Stream"/> provising data.</returns>
+		/// <returns>Returns a <see cref="Stream"/> providing data.</returns>
 		public Stream GetSource()
 		{
 			return File.Open(fileName_, FileMode.Open, FileAccess.Read, FileShare.Read);
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipHelperStream.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipHelperStream.cs
@@ -95,7 +95,7 @@ public ZipHelperStream(Stream stream)
 		#endregion Constructors
 
 		/// <summary>
-		/// Get / set a value indicating wether the the underlying stream is owned or not.
+		/// Get / set a value indicating whether the the underlying stream is owned or not.
 		/// </summary>
 		/// <remarks>If the stream is owned it is closed when this instance is closed.</remarks>
 		public bool IsStreamOwner
@@ -303,7 +303,7 @@ private void WriteLocalHeader(ZipEntry entry, EntryPatchData patchData)
 		/// <param name="endLocation">Location, marking the end of block.</param>
 		/// <param name="minimumBlockSize">Minimum size of the block.</param>
 		/// <param name="maximumVariableData">The maximum variable data.</param>
-		/// <returns>Eeturns the offset of the first byte after the signature; -1 if not found</returns>
+		/// <returns>Returns the offset of the first byte after the signature; -1 if not found</returns>
 		public long LocateBlockWithSignature(int signature, long endLocation, int minimumBlockSize, int maximumVariableData)
 		{
 			long pos = endLocation - minimumBlockSize;
@@ -332,7 +332,7 @@ public long LocateBlockWithSignature(int signature, long endLocation, int minimu
 		/// </summary>
 		/// <param name="noOfEntries">The number of entries in the central directory.</param>
 		/// <param name="sizeEntries">The size of entries in the central directory.</param>
-		/// <param name="centralDirOffset">The offset of the dentral directory.</param>
+		/// <param name="centralDirOffset">The offset of the central directory.</param>
 		public void WriteZip64EndOfCentralDirectory(long noOfEntries, long sizeEntries, long centralDirOffset)
 		{
 			long centralSignatureOffset = centralDirOffset + sizeEntries;
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipInputStream.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipInputStream.cs
diff --git a/src/ICSharpCode.SharpZipLib/Zip/ZipStrings.cs b/src/ICSharpCode.SharpZipLib/Zip/ZipStrings.cs

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public long Value`
`134`	`134`	`{`
`135`	`135`	`get`
`136`	`136`	`{`
`137`		`- // Tehcnically, the output should be:`
	`137`	`+ // Technically, the output should be:`
`138`	`138`	`//return (long)(~checkValue ^ crcXor);`
`139`	`139`	`// but x ^ 0 = x, so there is no point in adding`
`140`	`140`	`// the XOR operation`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public string Name`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`/// <summary>`
`81`		`- /// Get set a value indicating wether scanning should continue or not.`
	`81`	`+ /// Get set a value indicating whether scanning should continue or not.`
`82`	`82`	`/// </summary>`
`83`	`83`	`public bool ContinueRunning`
`84`	`84`	`{`
`@@ -209,7 +209,7 @@ public Exception Exception`
`209`	`209`	`}`
`210`	`210`
`211`	`211`	`/// <summary>`
`212`		`- /// Get / set a value indicating wether scanning should continue.`
	`212`	`+ /// Get / set a value indicating whether scanning should continue.`
`213`	`213`	`/// </summary>`
`214`	`214`	`public bool ContinueRunning`
`215`	`215`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ protected TarArchive()`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/// <summary>`
`64`		`- /// Initalise a TarArchive for input.`
	`64`	`+ /// Initialise a TarArchive for input.`
`65`	`65`	`/// </summary>`
`66`	`66`	`/// <param name="stream">The <see cref="TarInputStream"/> to use for input.</param>`
`67`	`67`	`protected TarArchive(TarInputStream stream)`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public bool AllowParentTraversal`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/// <summary>`
`84`		`- /// Gets or sets a value indicating wether paths on incoming values should be removed.`
	`84`	`+ /// Gets or sets a value indicating whether paths on incoming values should be removed.`
`85`	`85`	`/// </summary>`
`86`	`86`	`public bool TrimIncomingPaths`
`87`	`87`	`{`