Fix XML comment warnings

Author: siegfriedpammer

src/ICSharpCode.SharpZipLib/BZip2/BZip2InputStream.cs

@@ -18,7 +18,73 @@ public class BZip2InputStream : Stream
 		const int NO_RAND_PART_B_STATE = 6;
 		const int NO_RAND_PART_C_STATE = 7;
 		#endregion
-		#region Constructors
+
+		#region Instance Fields
+		/*--
+		index of the last char in the block, so
+		the block size == last + 1.
+		--*/
+		int last;
+
+		/*--
+		index in zptr[] of original string after sorting.
+		--*/
+		int origPtr;
+
+		/*--
+		always: in the range 0 .. 9.
+		The current block size is 100000 * this number.
+		--*/
+		int blockSize100k;
+
+		bool blockRandomised;
+
+		int bsBuff;
+		int bsLive;
+		IChecksum mCrc = new BZip2Crc();
+
+		bool[] inUse = new bool[256];
+		int nInUse;
+
+		byte[] seqToUnseq = new byte[256];
+		byte[] unseqToSeq = new byte[256];
+
+		byte[] selector = new byte[BZip2Constants.MaximumSelectors];
+		byte[] selectorMtf = new byte[BZip2Constants.MaximumSelectors];
+
+		int[] tt;
+		byte[] ll8;
+
+		/*--
+		freq table collected to save a pass over the data
+		during decompression.
+		--*/
+		int[] unzftab = new int[256];
+
+		int[][] limit = new int[BZip2Constants.GroupCount][];
+		int[][] baseArray = new int[BZip2Constants.GroupCount][];
+		int[][] perm = new int[BZip2Constants.GroupCount][];
+		int[] minLens = new int[BZip2Constants.GroupCount];
+
+		Stream baseStream;
+		bool streamEnd;
+
+		int currentChar = -1;
+
+		int currentState = START_BLOCK_STATE;
+
+		int storedBlockCRC, storedCombinedCRC;
+		int computedBlockCRC;
+		uint computedCombinedCRC;
+
+		int count, chPrev, ch2;
+		int tPos;
+		int rNToGo;
+		int rTPos;
+		int i2, j2;
+		byte z;
+		#endregion
+
 		/// <summary>
 		/// Construct instance for reading from stream
 		/// </summary>
@@ -38,17 +104,11 @@ public BZip2InputStream(Stream stream)
 			SetupBlock();
 		}
 
-		#endregion
-
 		/// <summary>
 		/// Get/set flag indicating ownership of underlying stream.
-		/// When the flag is true <see cref="Close"></see> will close the underlying stream also.
+		/// When the flag is true <see cref="Stream.Dispose()" /> will close the underlying stream also.
 		/// </summary>
-		public bool IsStreamOwner {
-			get { return isStreamOwner; }
-			set { isStreamOwner = value; }
-		}
-
+		public bool IsStreamOwner { get; set; } = true;
 
 		#region Stream Overrides
 		/// <summary>
@@ -838,72 +898,5 @@ static void HbCreateDecodeTables(int[] limit, int[] baseArray, int[] perm, char[
 				baseArray[i] = ((limit[i - 1] + 1) << 1) - baseArray[i];
 			}
 		}
-
-		#region Instance Fields
-		/*--
-		index of the last char in the block, so
-		the block size == last + 1.
-		--*/
-		int last;
-
-		/*--
-		index in zptr[] of original string after sorting.
-		--*/
-		int origPtr;
-
-		/*--
-		always: in the range 0 .. 9.
-		The current block size is 100000 * this number.
-		--*/
-		int blockSize100k;
-
-		bool blockRandomised;
-
-		int bsBuff;
-		int bsLive;
-		IChecksum mCrc = new BZip2Crc();
-
-		bool[] inUse = new bool[256];
-		int nInUse;
-
-		byte[] seqToUnseq = new byte[256];
-		byte[] unseqToSeq = new byte[256];
-
-		byte[] selector = new byte[BZip2Constants.MaximumSelectors];
-		byte[] selectorMtf = new byte[BZip2Constants.MaximumSelectors];
-
-		int[] tt;
-		byte[] ll8;
-
-		/*--
-		freq table collected to save a pass over the data
-		during decompression.
-		--*/
-		int[] unzftab = new int[256];
-
-		int[][] limit = new int[BZip2Constants.GroupCount][];
-		int[][] baseArray = new int[BZip2Constants.GroupCount][];
-		int[][] perm = new int[BZip2Constants.GroupCount][];
-		int[] minLens = new int[BZip2Constants.GroupCount];
-
-		Stream baseStream;
-		bool streamEnd;
-
-		int currentChar = -1;
-
-		int currentState = START_BLOCK_STATE;
-
-		int storedBlockCRC, storedCombinedCRC;
-		int computedBlockCRC;
-		uint computedCombinedCRC;
-
-		int count, chPrev, ch2;
-		int tPos;
-		int rNToGo;
-		int rTPos;
-		int i2, j2;
-		byte z;
-		bool isStreamOwner = true;
-		#endregion
 	}
 }

src/ICSharpCode.SharpZipLib/BZip2/BZip2OutputStream.cs

@@ -41,7 +41,69 @@ because the number of elems to sort is
 											  };
 		#endregion
 
-		#region Constructors
+		#region Instance Fields
+		/*--
+		index of the last char in the block, so
+		the block size == last + 1.
+		--*/
+		int last;
+
+		/*--
+		index in zptr[] of original string after sorting.
+		--*/
+		int origPtr;
+
+		/*--
+		always: in the range 0 .. 9.
+		The current block size is 100000 * this number.
+		--*/
+		int blockSize100k;
+
+		bool blockRandomised;
+
+		int bytesOut;
+		int bsBuff;
+		int bsLive;
+		IChecksum mCrc = new BZip2Crc();
+
+		bool[] inUse = new bool[256];
+		int nInUse;
+
+		char[] seqToUnseq = new char[256];
+		char[] unseqToSeq = new char[256];
+
+		char[] selector = new char[BZip2Constants.MaximumSelectors];
+		char[] selectorMtf = new char[BZip2Constants.MaximumSelectors];
+
+		byte[] block;
+		int[] quadrant;
+		int[] zptr;
+		short[] szptr;
+		int[] ftab;
+
+		int nMTF;
+
+		int[] mtfFreq = new int[BZip2Constants.MaximumAlphaSize];
+
+		/*
+		* Used when sorting.  If too many long comparisons
+		* happen, we stop sorting, randomise the block
+		* slightly, and try again.
+		*/
+		int workFactor;
+		int workDone;
+		int workLimit;
+		bool firstAttempt;
+		int nBlocksRandomised;
+
+		int currentChar = -1;
+		int runLength;
+		uint blockCRC, combinedCRC;
+		int allowableBlockSize;
+		Stream baseStream;
+		bool disposed_;
+		#endregion
+
 		/// <summary>
 		/// Construct a default output stream with maximum block size
 		/// </summary>
@@ -77,9 +139,7 @@ public BZip2OutputStream(Stream stream, int blockSize)
 			Initialize();
 			InitBlock();
 		}
-		#endregion
 
-		#region Destructor
 		/// <summary>
 		/// Ensures that resources are freed and other cleanup operations 
 		/// are performed when the garbage collector reclaims the BZip2OutputStream.
@@ -88,20 +148,14 @@ public BZip2OutputStream(Stream stream, int blockSize)
 		{
 			Dispose(false);
 		}
-		#endregion
 
 		/// <summary>
-		/// Get/set flag indicating ownership of underlying stream.
-		/// When the flag is true <see cref="Close"></see> will close the underlying stream also.
+		/// Gets or sets a flag indicating ownership of underlying stream.
+		/// When the flag is true <see cref="Stream.Dispose()" /> will close the underlying stream also.
 		/// </summary>
-		public bool IsStreamOwner
-		{
-			get { return isStreamOwner; }
-			set { isStreamOwner = value; }
-		}
+		/// <remarks>The default value is true.</remarks>
+		public bool IsStreamOwner { get; set; } = true;
 
-
-		#region Stream overrides
 		/// <summary>
 		/// Gets a value indicating whether the current stream supports reading
 		/// </summary>
@@ -259,7 +313,6 @@ public override void WriteByte(byte value)
 			}
 		}
 
-		#endregion
 		void MakeMaps()
 		{
 			nInUse = 0;
@@ -1730,70 +1783,5 @@ struct StackElement
 			public int hh;
 			public int dd;
 		}
-
-		#region Instance Fields
-		bool isStreamOwner = true;
-
-		/*--
-		index of the last char in the block, so
-		the block size == last + 1.
-		--*/
-		int last;
-
-		/*--
-		index in zptr[] of original string after sorting.
-		--*/
-		int origPtr;
-
-		/*--
-		always: in the range 0 .. 9.
-		The current block size is 100000 * this number.
-		--*/
-		int blockSize100k;
-
-		bool blockRandomised;
-
-		int bytesOut;
-		int bsBuff;
-		int bsLive;
-		IChecksum mCrc = new BZip2Crc();
-
-		bool[] inUse = new bool[256];
-		int nInUse;
-
-		char[] seqToUnseq = new char[256];
-		char[] unseqToSeq = new char[256];
-
-		char[] selector = new char[BZip2Constants.MaximumSelectors];
-		char[] selectorMtf = new char[BZip2Constants.MaximumSelectors];
-
-		byte[] block;
-		int[] quadrant;
-		int[] zptr;
-		short[] szptr;
-		int[] ftab;
-
-		int nMTF;
-
-		int[] mtfFreq = new int[BZip2Constants.MaximumAlphaSize];
-
-		/*
-		* Used when sorting.  If too many long comparisons
-		* happen, we stop sorting, randomise the block
-		* slightly, and try again.
-		*/
-		int workFactor;
-		int workDone;
-		int workLimit;
-		bool firstAttempt;
-		int nBlocksRandomised;
-
-		int currentChar = -1;
-		int runLength;
-		uint blockCRC, combinedCRC;
-		int allowableBlockSize;
-		Stream baseStream;
-		bool disposed_;
-		#endregion
 	}
 }

src/ICSharpCode.SharpZipLib/Lzw/LzwInputStream.cs

@@ -44,16 +44,11 @@ namespace ICSharpCode.SharpZipLib.Lzw
 	public class LzwInputStream : Stream
 	{
 		/// <summary>
-		/// Get/set flag indicating ownership of underlying stream.
-		/// When the flag is true <see cref="Close"/> will close the underlying stream also.
+		/// Gets or sets a flag indicating ownership of underlying stream.
+		/// When the flag is true <see cref="Stream.Dispose()" /> will close the underlying stream also.
 		/// </summary>
-		/// <remarks>
-		/// The default value is true.
-		/// </remarks>
-		public bool IsStreamOwner {
-			get { return isStreamOwner; }
-			set { isStreamOwner = value; }
-		}
+		/// <remarks>The default value is true.</remarks>
+		public bool IsStreamOwner { get; set; } = true;
 
 		/// <summary>
 		/// Creates a LzwInputStream
@@ -485,7 +480,7 @@ protected override void Dispose(bool disposing)
 		{
 			if (!isClosed) {
 				isClosed = true;
-				if (isStreamOwner) {
+				if (IsStreamOwner) {
 					baseInputStream.Dispose();
 				}
 			}
@@ -497,12 +492,6 @@ protected override void Dispose(bool disposing)
 
 		Stream baseInputStream;
 
-		/// <summary>
-		/// Flag indicating wether this instance is designated the stream owner.
-		/// When closing if this flag is true the underlying stream is closed.
-		/// </summary>
-		bool isStreamOwner = true;
-
 		/// <summary>
 		/// Flag indicating wether this instance has been closed or not.
 		/// </summary>