Updated documentation for exception classes

Author: sharwell

src/corelib/Core/Exceptions/CDNNotEnabledException.cs

@@ -1,15 +1,41 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Providers;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when an attempt is made to modify CDN properties
+    /// of a container which is not CDN-enabled.
+    /// </summary>
+    /// <seealso cref="IObjectStorageProvider"/>
     [Serializable]
     public class CDNNotEnabledException : Exception
     {
-        public CDNNotEnabledException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CDNNotEnabledException"/> class.
+        /// </summary>
+        public CDNNotEnabledException()
+        {
+        }
 
-        public CDNNotEnabledException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CDNNotEnabledException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public CDNNotEnabledException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CDNNotEnabledException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected CDNNotEnabledException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/CidrFormatException.cs

@@ -1,15 +1,40 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Validators;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// Represents errors that occur while validating a CIDR.
+    /// </summary>
+    /// <seealso cref="INetworksValidator.ValidateCidr"/>
     [Serializable]
     public class CidrFormatException : Exception
     {
-        public CidrFormatException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CidrFormatException"/> class.
+        /// </summary>
+        public CidrFormatException()
+        {
+        }
 
-        public CidrFormatException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CidrFormatException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public CidrFormatException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CidrFormatException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected CidrFormatException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/ContainerNameException.cs

@@ -1,15 +1,41 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Providers;
+using net.openstack.Core.Validators;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// Represents errors that occur while validating a container name for an <see cref="IObjectStorageProvider"/>.
+    /// </summary>
+    /// <seealso cref="IObjectStorageValidator.ValidateContainerName"/>
     [Serializable]
     public class ContainerNameException : Exception
     {
-        public ContainerNameException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ContainerNameException"/> class.
+        /// </summary>
+        public ContainerNameException()
+        {
+        }
 
-        public ContainerNameException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ContainerNameException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public ContainerNameException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ContainerNameException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected ContainerNameException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/InvalidCloudIdentityException.cs

@@ -1,13 +1,33 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Domain;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception thrown when the <see cref="CloudIdentity"/> instance passed
+    /// to a provider method is not supported by that provider.
+    /// </summary>
     [Serializable]
     internal class InvalidCloudIdentityException : Exception
     {
-        public InvalidCloudIdentityException(string message) : base(message) {}
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidCloudIdentityException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public InvalidCloudIdentityException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidCloudIdentityException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected InvalidCloudIdentityException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/NoDefaultRegionSetException.cs

@@ -3,13 +3,30 @@
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when a service endpoint could not be obtained because
+    /// no region was specified and no default region is available for the provider.
+    /// </summary>
     [Serializable]
     public class NoDefaultRegionSetException : Exception
     {
-        public NoDefaultRegionSetException(string message) : base(message)
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NoDefaultRegionSetException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public NoDefaultRegionSetException(string message)
+            : base(message)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NoDefaultRegionSetException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected NoDefaultRegionSetException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/ObjectNameException.cs

@@ -1,15 +1,41 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Providers;
+using net.openstack.Core.Validators;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// Represents errors that occur while validating an object name for an <see cref="IObjectStorageProvider"/>.
+    /// </summary>
+    /// <seealso cref="IObjectStorageValidator.ValidateObjectName"/>
     [Serializable]
     public class ObjectNameException : Exception
     {
-        public ObjectNameException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ObjectNameException"/> class.
+        /// </summary>
+        public ObjectNameException()
+        {
+        }
 
-        public ObjectNameException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ObjectNameException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public ObjectNameException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ObjectNameException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected ObjectNameException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/ServerEnteredErrorStateException.cs

@@ -1,26 +1,57 @@
 using System;
 using System.Runtime.Serialization;
 using System.Security;
+using net.openstack.Core.Domain;
+using net.openstack.Core.Providers;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when the server enters an error state during a
+    /// call to <see cref="O:IComputeProvider.WaitForServerState"/> or <see cref="O:IComputeProvider.WaitForImageState"/>.
+    /// </summary>
     [Serializable]
     public class ServerEnteredErrorStateException : Exception
     {
-        public string Status { get; private set; }
+        /// <summary>
+        /// The state of the server or image.
+        /// </summary>
+        /// <seealso cref="ServerState"/>
+        /// <seealso cref="ImageState"/>
+        public string Status
+        {
+            get;
+            private set;
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ServerEnteredErrorStateException"/> class
+        /// with the specified error state.
+        /// </summary>
+        /// <param name="status">The error state entered by the server or image.</param>
         public ServerEnteredErrorStateException(string status)
             : base(string.Format("The server entered an error state: '{0}'", status))
         {
             Status = status;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ServerEnteredErrorStateException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected ServerEnteredErrorStateException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            if (info == null)
+                throw new ArgumentNullException("info");
+
             Status = (string)info.GetValue("Status", typeof(string));
         }
 
+        /// <inheritdoc/>
         [SecurityCritical]
         public override void GetObjectData(SerializationInfo info, StreamingContext context)
         {

src/corelib/Core/Exceptions/TTLLengthException.cs

@@ -3,13 +3,37 @@
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when the TTL argument to a method is outside
+    /// the range supported by the provider.
+    /// </summary>
     [Serializable]
     public class TTLLengthException : Exception
     {
-        public TTLLengthException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TTLLengthException"/> class.
+        /// </summary>
+        public TTLLengthException()
+        {
+        }
 
-        public TTLLengthException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TTLLengthException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public TTLLengthException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TTLLengthException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected TTLLengthException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {

src/corelib/Core/Exceptions/UserAuthenticationException.cs

@@ -1,13 +1,33 @@
 using System;
 using System.Runtime.Serialization;
+using net.openstack.Core.Domain;
 
 namespace net.openstack.Core.Exceptions
 {
+    /// <summary>
+    /// The exception thrown when the user authentication process fails, or
+    /// the authentication process did not provide a value for the <see cref="UserAccess.ServiceCatalog"/>.
+    /// </summary>
     [Serializable]
     public class UserAuthenticationException : Exception
     {
-        public UserAuthenticationException(string message) : base(message) {}
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UserAuthenticationException"/> class
+        /// with the specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public UserAuthenticationException(string message)
+            : base(message)
+        {
+        }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UserAuthenticationException"/> class with
+        /// serialized data.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="info"/> is <c>null</c>.</exception>
         protected UserAuthenticationException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {