Consistency - Exceptions

* No functional or API changes
* All exception classes now have conssitent variable names and XML comments

Author: McNeight

ICSharpCode.SharpZipLib/BZip2/BZip2Exception.cs

@@ -4,44 +4,44 @@
 namespace ICSharpCode.SharpZipLib.BZip2
 {
 	/// <summary>
-	/// BZip2Exception represents exceptions specific to Bzip2 algorithm
+	/// BZip2Exception represents exceptions specific to BZip2 classes and code.
 	/// </summary>
 	[Serializable]
 	public class BZip2Exception : SharpZipBaseException
 	{
-
 		/// <summary>
 		/// Deserialization constructor 
 		/// </summary>
 		/// <param name="info"><see cref="SerializationInfo"/> for this constructor</param>
 		/// <param name="context"><see cref="StreamingContext"/> for this constructor</param>
 		protected BZip2Exception(SerializationInfo info, StreamingContext context)
 			: base(info, context)
-
 		{
 		}
+
 		/// <summary>
-		/// Initialise a new instance of BZip2Exception.
+		/// Initialise a new instance of <see cref="BZip2Exception" />.
 		/// </summary>
 		public BZip2Exception()
 		{
 		}
 
 		/// <summary>
-		/// Initialise a new instance of BZip2Exception with its message set to message.
+		/// Initialise a new instance of <see cref="BZip2Exception" /> with its message string.
 		/// </summary>
-		/// <param name="message">The message describing the error.</param>
-		public BZip2Exception(string message) : base(message)
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
+		public BZip2Exception(string message)
+			: base(message)
 		{
 		}
 
 		/// <summary>
-		/// Initialise an instance of BZip2Exception
+		/// Initialise a new instance of <see cref="BZip2Exception" />.
 		/// </summary>
-		/// <param name="message">A message describing the error.</param>
-		/// <param name="exception">The exception that is the cause of the current exception.</param>
-		public BZip2Exception(string message, Exception exception)
-			: base(message, exception)
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
+		/// <param name="innerException">The <see cref="Exception"/> that caused this exception.</param>
+		public BZip2Exception(string message, Exception innerException)
+			: base(message, innerException)
 		{
 		}
 	}

ICSharpCode.SharpZipLib/GZip/GZipException.cs

@@ -4,7 +4,7 @@
 namespace ICSharpCode.SharpZipLib.GZip
 {
 	/// <summary>
-	/// GZipException represents a Gzip specific exception	
+	/// GZipException represents exceptions specific to GZip classes and code.
 	/// </summary>
 	[Serializable]
 	public class GZipException : SharpZipBaseException
@@ -16,19 +16,18 @@ public class GZipException : SharpZipBaseException
 		/// <param name="context"><see cref="StreamingContext"/> for this constructor</param>
 		protected GZipException(SerializationInfo info, StreamingContext context)
 			: base(info, context)
-
 		{
 		}
 
 		/// <summary>
-		/// Initialise a new instance of GZipException
+		/// Initialise a new instance of <see cref="GZipException" />.
 		/// </summary>
 		public GZipException()
 		{
 		}
 
 		/// <summary>
-		/// Initialise a new instance of GZipException with its message string.
+		/// Initialise a new instance of <see cref="GZipException" /> with its message string.
 		/// </summary>
 		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		public GZipException(string message)
@@ -37,7 +36,7 @@ public GZipException(string message)
 		}
 
 		/// <summary>
-		/// Initialise a new instance of <see cref="GZipException"></see>.
+		/// Initialise a new instance of <see cref="GZipException" />.
 		/// </summary>
 		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		/// <param name="innerException">The <see cref="Exception"/> that caused this exception.</param>

ICSharpCode.SharpZipLib/Lzw/LzwException.cs

@@ -4,12 +4,11 @@
 namespace ICSharpCode.SharpZipLib.Lzw
 {
 	/// <summary>
-	/// LzwException represents a LZW specific exception
+	/// LzwException represents exceptions specific to LZW classes and code.
 	/// </summary>
 	[Serializable]
 	public class LzwException : SharpZipBaseException
 	{
-
 		/// <summary>
 		/// Deserialization constructor 
 		/// </summary>
@@ -21,14 +20,14 @@ protected LzwException(SerializationInfo info, StreamingContext context)
 		}
 
 		/// <summary>
-		/// Initialise a new instance of LzwException
+		/// Initialise a new instance of <see cref="LzwException" />.
 		/// </summary>
 		public LzwException()
 		{
 		}
 
 		/// <summary>
-		/// Initialise a new instance of LzwException with its message string.
+		/// Initialise a new instance of <see cref="LzwException" /> with its message string.
 		/// </summary>
 		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		public LzwException(string message)
@@ -37,7 +36,7 @@ public LzwException(string message)
 		}
 
 		/// <summary>
-		/// Initialise a new instance of <see cref="LzwException"></see>.
+		/// Initialise a new instance of <see cref="LzwException" />.
 		/// </summary>
 		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		/// <param name="innerException">The <see cref="Exception"/> that caused this exception.</param>

ICSharpCode.SharpZipLib/Tar/TarException.cs

@@ -4,7 +4,7 @@
 namespace ICSharpCode.SharpZipLib.Tar
 {
 	/// <summary>
-	/// TarExceptions are used for exceptions specific to tar classes and code.	
+	/// TarException represents exceptions specific to Tar classes and code.
 	/// </summary>
 	[Serializable]
 	public class TarException : SharpZipBaseException
@@ -16,33 +16,32 @@ public class TarException : SharpZipBaseException
 		/// <param name="context"><see cref="StreamingContext"/> for this constructor</param>
 		protected TarException(SerializationInfo info, StreamingContext context)
 			: base(info, context)
-
 		{
 		}
 
 		/// <summary>
-		/// Initialises a new instance of the TarException class.
+		/// Initialise a new instance of <see cref="TarException" />.
 		/// </summary>
 		public TarException()
 		{
 		}
 
 		/// <summary>
-		/// Initialises a new instance of the TarException class with a specified message.
+		/// Initialise a new instance of <see cref="TarException" /> with its message string.
 		/// </summary>
-		/// <param name="message">The message that describes the error.</param>
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		public TarException(string message)
 			: base(message)
 		{
 		}
 
 		/// <summary>
-		/// 
+		/// Initialise a new instance of <see cref="TarException" />.
 		/// </summary>
-		/// <param name="message">A message describing the error.</param>
-		/// <param name="exception">The exception that is the cause of the current exception.</param>
-		public TarException(string message, Exception exception)
-			: base(message, exception)
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
+		/// <param name="innerException">The <see cref="Exception"/> that caused this exception.</param>
+		public TarException(string message, Exception innerException)
+			: base(message, innerException)
 		{
 		}
 	}

ICSharpCode.SharpZipLib/Zip/ZipException.cs

@@ -4,7 +4,7 @@
 namespace ICSharpCode.SharpZipLib.Zip
 {
 	/// <summary>
-	/// Represents exception conditions specific to Zip archive handling
+	/// ZipException represents exceptions specific to Zip classes and code.
 	/// </summary>
 	[Serializable]
 	public class ZipException : SharpZipBaseException
@@ -20,28 +20,28 @@ protected ZipException(SerializationInfo info, StreamingContext context)
 		}
 
 		/// <summary>
-		/// Initializes a new instance of the ZipException class.
+		/// Initialise a new instance of <see cref="ZipException" />.
 		/// </summary>
 		public ZipException()
 		{
 		}
 
 		/// <summary>
-		/// Initializes a new instance of the ZipException class with a specified error message.
+		/// Initialise a new instance of <see cref="ZipException" /> with its message string.
 		/// </summary>
-		/// <param name="message">The error message that explains the reason for the exception.</param>
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
 		public ZipException(string message)
 			: base(message)
 		{
 		}
 
 		/// <summary>
-		/// Initialise a new instance of ZipException.
+		/// Initialise a new instance of <see cref="ZipException" />.
 		/// </summary>
-		/// <param name="message">A message describing the error.</param>
-		/// <param name="exception">The exception that is the cause of the current exception.</param>
-		public ZipException(string message, Exception exception)
-			: base(message, exception)
+		/// <param name="message">A <see cref="string"/> that describes the error.</param>
+		/// <param name="innerException">The <see cref="Exception"/> that caused this exception.</param>
+		public ZipException(string message, Exception innerException)
+			: base(message, innerException)
 		{
 		}
 	}