Add MySqlError.ErrorCode. For #1011

bgrainger · bgrainger · commit d465650646ac · 2021-07-02T10:39:40.000-07:00
Add documentation.

Will make Code [Obsolete] in a future version.
diff --git a/docs/content/api/MySqlConnector/MySqlError/Code.md b/docs/content/api/MySqlConnector/MySqlError/Code.md
@@ -4,6 +4,8 @@ title: MySqlError.Code property
 
 # MySqlError.Code property
 
+The numeric error code. Prefer to use [`ErrorCode`](../ErrorCode/).
+
 ```csharp
 public int Code { get; }
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlError/ErrorCode.md b/docs/content/api/MySqlConnector/MySqlError/ErrorCode.md
@@ -0,0 +1,20 @@
+---
+title: MySqlError.ErrorCode property
+---
+
+# MySqlError.ErrorCode property
+
+The [`MySqlErrorCode`](../../MySqlErrorCodeType/) for the error or warning.
+
+```csharp
+public MySqlErrorCode ErrorCode { get; }
+```
+
+## See Also
+
+* enum [MySqlErrorCode](../../MySqlErrorCodeType/)
+* class [MySqlError](../../MySqlErrorType/)
+* namespace [MySqlConnector](../../MySqlErrorType/)
+* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
+
+<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->
diff --git a/docs/content/api/MySqlConnector/MySqlError/Level.md b/docs/content/api/MySqlConnector/MySqlError/Level.md
@@ -4,6 +4,8 @@ title: MySqlError.Level property
 
 # MySqlError.Level property
 
+The error level. This comes from the MySQL Server. Possible values include `Note`, `Warning`, and `Error`.
+
 ```csharp
 public string Level { get; }
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlError/Message.md b/docs/content/api/MySqlConnector/MySqlError/Message.md
@@ -4,6 +4,8 @@ title: MySqlError.Message property
 
 # MySqlError.Message property
 
+A human-readable description of the error or warning.
+
 ```csharp
 public string Message { get; }
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlErrorType.md b/docs/content/api/MySqlConnector/MySqlErrorType.md
@@ -4,6 +4,8 @@ title: MySqlError
 
 # MySqlError class
 
+[`MySqlError`](../MySqlErrorType/) represents an error or warning that occurred during the execution of a SQL statement.
+
 ```csharp
 public sealed class MySqlError
 ```
@@ -12,9 +14,10 @@ public sealed class MySqlError
 
 | name | description |
 | --- | --- |
-| [Code](../MySqlError/Code/) { get; } |  |
-| [Level](../MySqlError/Level/) { get; } |  |
-| [Message](../MySqlError/Message/) { get; } |  |
+| [Code](../MySqlError/Code/) { get; } | The numeric error code. Prefer to use [`ErrorCode`](../MySqlError/ErrorCode/). |
+| [ErrorCode](../MySqlError/ErrorCode/) { get; } | The [`MySqlErrorCode`](../MySqlErrorCodeType/) for the error or warning. |
+| [Level](../MySqlError/Level/) { get; } | The error level. This comes from the MySQL Server. Possible values include `Note`, `Warning`, and `Error`. |
+| [Message](../MySqlError/Message/) { get; } | A human-readable description of the error or warning. |
 
 ## See Also
 
diff --git a/docs/content/api/MySqlConnector/MySqlInfoMessageEventArgs/Errors.md b/docs/content/api/MySqlConnector/MySqlInfoMessageEventArgs/Errors.md
@@ -4,6 +4,8 @@ title: MySqlInfoMessageEventArgs.Errors property
 
 # MySqlInfoMessageEventArgs.Errors property
 
+The list of errors being reported.
+
 ```csharp
 public IReadOnlyList<MySqlError> Errors { get; }
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlInfoMessageEventArgsType.md b/docs/content/api/MySqlConnector/MySqlInfoMessageEventArgsType.md
@@ -4,6 +4,8 @@ title: MySqlInfoMessageEventArgs
 
 # MySqlInfoMessageEventArgs class
 
+[`MySqlInfoMessageEventArgs`](../MySqlInfoMessageEventArgsType/) contains the data supplied to the [`MySqlInfoMessageEventHandler`](../MySqlInfoMessageEventHandlerType/) event handler.
+
 ```csharp
 public sealed class MySqlInfoMessageEventArgs : EventArgs
 ```
@@ -12,7 +14,7 @@ public sealed class MySqlInfoMessageEventArgs : EventArgs
 
 | name | description |
 | --- | --- |
-| [Errors](../MySqlInfoMessageEventArgs/Errors/) { get; } |  |
+| [Errors](../MySqlInfoMessageEventArgs/Errors/) { get; } | The list of errors being reported. |
 
 ## See Also
 
diff --git a/docs/content/api/MySqlConnector/MySqlInfoMessageEventHandlerType.md b/docs/content/api/MySqlConnector/MySqlInfoMessageEventHandlerType.md
@@ -4,10 +4,17 @@ title: MySqlInfoMessageEventHandler
 
 # MySqlInfoMessageEventHandler delegate
 
+Defines the event handler for [`InfoMessage`](../MySqlConnection/InfoMessage/).
+
 ```csharp
 public delegate void MySqlInfoMessageEventHandler(object sender, MySqlInfoMessageEventArgs args);
 ```
 
+| parameter | description |
+| --- | --- |
+| sender | The sender. This is the associated [`MySqlConnection`](../MySqlConnectionType/). |
+| args | The [`MySqlInfoMessageEventArgs`](../MySqlInfoMessageEventArgsType/) containing the errors. |
+
 ## See Also
 
 * class [MySqlInfoMessageEventArgs](../MySqlInfoMessageEventArgsType/)
diff --git a/docs/content/api/MySqlConnectorAssembly.md b/docs/content/api/MySqlConnectorAssembly.md
@@ -30,14 +30,14 @@ title: MySqlConnector
 | enum [MySqlDateTimeKind](../MySqlConnector/MySqlDateTimeKindType/) | The DateTimeKind used when reading DateTime from the database. |
 | class [MySqlDbColumn](../MySqlConnector/MySqlDbColumnType/) |  |
 | enum [MySqlDbType](../MySqlConnector/MySqlDbTypeType/) |  |
-| class [MySqlError](../MySqlConnector/MySqlErrorType/) |  |
+| class [MySqlError](../MySqlConnector/MySqlErrorType/) | [`MySqlError`](../MySqlConnector/MySqlErrorType/) represents an error or warning that occurred during the execution of a SQL statement. |
 | enum [MySqlErrorCode](../MySqlConnector/MySqlErrorCodeType/) | MySQL Server error codes. Taken from [Server Error Codes and Messages](https://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html). |
 | class [MySqlException](../MySqlConnector/MySqlExceptionType/) | [`MySqlException`](../MySqlConnector/MySqlExceptionType/) is thrown when MySQL Server returns an error code, or there is a communication error with the server. |
 | class [MySqlGeometry](../MySqlConnector/MySqlGeometryType/) | Represents MySQL's internal GEOMETRY format: https://dev.mysql.com/doc/refman/8.0/en/gis-data-formats.html#gis-internal-format |
 | enum [MySqlGuidFormat](../MySqlConnector/MySqlGuidFormatType/) | Determines which column type (if any) should be read as a `System.Guid`. |
 | class [MySqlHelper](../MySqlConnector/MySqlHelperType/) |  |
-| class [MySqlInfoMessageEventArgs](../MySqlConnector/MySqlInfoMessageEventArgsType/) |  |
-| delegate [MySqlInfoMessageEventHandler](../MySqlConnector/MySqlInfoMessageEventHandlerType/) |  |
+| class [MySqlInfoMessageEventArgs](../MySqlConnector/MySqlInfoMessageEventArgsType/) | [`MySqlInfoMessageEventArgs`](../MySqlConnector/MySqlInfoMessageEventArgsType/) contains the data supplied to the [`MySqlInfoMessageEventHandler`](../MySqlConnector/MySqlInfoMessageEventHandlerType/) event handler. |
+| delegate [MySqlInfoMessageEventHandler](../MySqlConnector/MySqlInfoMessageEventHandlerType/) | Defines the event handler for [`InfoMessage`](../MySqlConnector/MySqlConnection/InfoMessage/). |
 | enum [MySqlLoadBalance](../MySqlConnector/MySqlLoadBalanceType/) |  |
 | class [MySqlParameter](../MySqlConnector/MySqlParameterType/) |  |
 | class [MySqlParameterCollection](../MySqlConnector/MySqlParameterCollectionType/) |  |
diff --git a/docs/content/api/MySqlConnectorNamespace.md b/docs/content/api/MySqlConnectorNamespace.md
@@ -28,14 +28,14 @@ title: MySqlConnector
 | enum [MySqlDateTimeKind](../MySqlConnector/MySqlDateTimeKindType/) | The DateTimeKind used when reading DateTime from the database. |
 | class [MySqlDbColumn](../MySqlConnector/MySqlDbColumnType/) |  |
 | enum [MySqlDbType](../MySqlConnector/MySqlDbTypeType/) |  |
-| class [MySqlError](../MySqlConnector/MySqlErrorType/) |  |
+| class [MySqlError](../MySqlConnector/MySqlErrorType/) | [`MySqlError`](../MySqlConnector/MySqlErrorType/) represents an error or warning that occurred during the execution of a SQL statement. |
 | enum [MySqlErrorCode](../MySqlConnector/MySqlErrorCodeType/) | MySQL Server error codes. Taken from [Server Error Codes and Messages](https://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html). |
 | class [MySqlException](../MySqlConnector/MySqlExceptionType/) | [`MySqlException`](../MySqlConnector/MySqlExceptionType/) is thrown when MySQL Server returns an error code, or there is a communication error with the server. |
 | class [MySqlGeometry](../MySqlConnector/MySqlGeometryType/) | Represents MySQL's internal GEOMETRY format: https://dev.mysql.com/doc/refman/8.0/en/gis-data-formats.html#gis-internal-format |
 | enum [MySqlGuidFormat](../MySqlConnector/MySqlGuidFormatType/) | Determines which column type (if any) should be read as a `System.Guid`. |
 | class [MySqlHelper](../MySqlConnector/MySqlHelperType/) |  |
-| class [MySqlInfoMessageEventArgs](../MySqlConnector/MySqlInfoMessageEventArgsType/) |  |
-| delegate [MySqlInfoMessageEventHandler](../MySqlConnector/MySqlInfoMessageEventHandlerType/) |  |
+| class [MySqlInfoMessageEventArgs](../MySqlConnector/MySqlInfoMessageEventArgsType/) | [`MySqlInfoMessageEventArgs`](../MySqlConnector/MySqlInfoMessageEventArgsType/) contains the data supplied to the [`MySqlInfoMessageEventHandler`](../MySqlConnector/MySqlInfoMessageEventHandlerType/) event handler. |
+| delegate [MySqlInfoMessageEventHandler](../MySqlConnector/MySqlInfoMessageEventHandlerType/) | Defines the event handler for [`InfoMessage`](../MySqlConnector/MySqlConnection/InfoMessage/). |
 | enum [MySqlLoadBalance](../MySqlConnector/MySqlLoadBalanceType/) |  |
 | class [MySqlParameter](../MySqlConnector/MySqlParameterType/) |  |
 | class [MySqlParameterCollection](../MySqlConnector/MySqlParameterCollectionType/) |  |
diff --git a/src/MySqlConnector/MySqlError.cs b/src/MySqlConnector/MySqlError.cs
@@ -1,16 +1,36 @@
 namespace MySqlConnector
 {
+	/// <summary>
+	/// <see cref="MySqlError"/> represents an error or warning that occurred during the execution of a SQL statement.
+	/// </summary>
 	public sealed class MySqlError
 	{
 		internal MySqlError(string level, int code, string message)
 		{
 			Level = level;
 			Code = code;
+			ErrorCode = (MySqlErrorCode) code;
 			Message = message;
 		}
 
+		/// <summary>
+		/// The error level. This comes from the MySQL Server. Possible values include <c>Note</c>, <c>Warning</c>, and <c>Error</c>.
+		/// </summary>
 		public string Level { get; }
+
+		/// <summary>
+		/// The numeric error code. Prefer to use <see cref="ErrorCode"/>.
+		/// </summary>
 		public int Code { get; }
+
+		/// <summary>
+		/// The <see cref="MySqlErrorCode"/> for the error or warning.
+		/// </summary>
+		public MySqlErrorCode ErrorCode { get; }
+
+		/// <summary>
+		/// A human-readable description of the error or warning.
+		/// </summary>
 		public string Message { get; }
 	};
 }
diff --git a/src/MySqlConnector/MySqlInfoMessageEventArgs.cs b/src/MySqlConnector/MySqlInfoMessageEventArgs.cs
@@ -3,12 +3,23 @@
 
 namespace MySqlConnector
 {
+	/// <summary>
+	/// <see cref="MySqlInfoMessageEventArgs"/> contains the data supplied to the <see cref="MySqlInfoMessageEventHandler"/> event handler.
+	/// </summary>
 	public sealed class MySqlInfoMessageEventArgs : EventArgs
 	{
 		internal MySqlInfoMessageEventArgs(IReadOnlyList<MySqlError> errors) => Errors = errors;
 
+		/// <summary>
+		/// The list of errors being reported.
+		/// </summary>
 		public IReadOnlyList<MySqlError> Errors { get; }
 	}
 
+	/// <summary>
+	/// Defines the event handler for <see cref="MySqlConnection.InfoMessage"/>.
+	/// </summary>
+	/// <param name="sender">The sender. This is the associated <see cref="MySqlConnection"/>.</param>
+	/// <param name="args">The <see cref="MySqlInfoMessageEventArgs"/> containing the errors.</param>
 	public delegate void MySqlInfoMessageEventHandler(object sender, MySqlInfoMessageEventArgs args);
 }
diff --git a/tests/SideBySide/ConnectionTests.cs b/tests/SideBySide/ConnectionTests.cs
@@ -32,7 +32,7 @@ public void GotInfoMessageForNonExistentTable()
 				Assert.Equal((int) MySqlErrorCode.BadTable, a.errors[0].Code);
 #else
 				Assert.Single(a.Errors);
-				Assert.Equal((int) MySqlErrorCode.BadTable, a.Errors[0].Code);
+				Assert.Equal(MySqlErrorCode.BadTable, a.Errors[0].ErrorCode);
 #endif
 			};
 
@@ -56,7 +56,7 @@ public void GotInfoMessageForNonExistentTableInTransaction()
 				Assert.Equal((int) MySqlErrorCode.BadTable, a.errors[0].Code);
 #else
 				Assert.Single(a.Errors);
-				Assert.Equal((int) MySqlErrorCode.BadTable, a.Errors[0].Code);
+				Assert.Equal(MySqlErrorCode.BadTable, a.Errors[0].ErrorCode);
 #endif
 			};
 
