Add documentation for MySqlConnectorFactory.

bgrainger · bgrainger · commit d3a3607de72c · 2020-07-01T10:57:00.000-07:00
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateBatch.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateBatch.md
@@ -4,6 +4,8 @@ title: CanCreateBatch
 
 # MySqlConnectorFactory.CanCreateBatch property
 
+Returns `true`.
+
 ```csharp
 public bool CanCreateBatch { get; }
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateCommandBuilder.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateCommandBuilder.md
@@ -0,0 +1,19 @@
+---
+title: CanCreateCommandBuilder
+---
+
+# MySqlConnectorFactory.CanCreateCommandBuilder property
+
+Returns `true`.
+
+```csharp
+public override bool CanCreateCommandBuilder { get; }
+```
+
+## See Also
+
+* class [MySqlConnectorFactory](../../MySqlConnectorFactoryType/)
+* namespace [MySqlConnector](../../MySqlConnectorFactoryType/)
+* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
+
+<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateDataAdapter.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateDataAdapter.md
@@ -0,0 +1,19 @@
+---
+title: CanCreateDataAdapter
+---
+
+# MySqlConnectorFactory.CanCreateDataAdapter property
+
+Returns `true`.
+
+```csharp
+public override bool CanCreateDataAdapter { get; }
+```
+
+## See Also
+
+* class [MySqlConnectorFactory](../../MySqlConnectorFactoryType/)
+* namespace [MySqlConnector](../../MySqlConnectorFactoryType/)
+* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
+
+<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateDataSourceEnumerator.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CanCreateDataSourceEnumerator.md
@@ -0,0 +1,23 @@
+---
+title: CanCreateDataSourceEnumerator
+---
+
+# MySqlConnectorFactory.CanCreateDataSourceEnumerator property
+
+Returns `false`.
+
+```csharp
+public override bool CanCreateDataSourceEnumerator { get; }
+```
+
+## Remarks
+
+DbDataSourceEnumerator is not supported by MySqlConnector.
+
+## See Also
+
+* class [MySqlConnectorFactory](../../MySqlConnectorFactoryType/)
+* namespace [MySqlConnector](../../MySqlConnectorFactoryType/)
+* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
+
+<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateBatch.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateBatch.md
@@ -4,6 +4,8 @@ title: CreateBatch
 
 # MySqlConnectorFactory.CreateBatch method
 
+Creates a new [`MySqlBatch`](../../MySqlBatchType/) object.
+
 ```csharp
 public MySqlBatch CreateBatch()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateBatchCommand.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateBatchCommand.md
@@ -4,6 +4,8 @@ title: CreateBatchCommand
 
 # MySqlConnectorFactory.CreateBatchCommand method
 
+Creates a new [`MySqlBatchCommand`](../../MySqlBatchCommandType/) object.
+
 ```csharp
 public MySqlBatchCommand CreateBatchCommand()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateCommand.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateCommand.md
@@ -4,6 +4,8 @@ title: CreateCommand
 
 # MySqlConnectorFactory.CreateCommand method
 
+Creates a new [`MySqlCommand`](../../MySqlCommandType/) object.
+
 ```csharp
 public override DbCommand CreateCommand()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateCommandBuilder.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateCommandBuilder.md
@@ -4,6 +4,8 @@ title: CreateCommandBuilder
 
 # MySqlConnectorFactory.CreateCommandBuilder method
 
+Creates a new [`MySqlCommandBuilder`](../../MySqlCommandBuilderType/) object.
+
 ```csharp
 public override DbCommandBuilder CreateCommandBuilder()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateConnection.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateConnection.md
@@ -4,6 +4,8 @@ title: CreateConnection
 
 # MySqlConnectorFactory.CreateConnection method
 
+Creates a new [`MySqlConnection`](../../MySqlConnectionType/) object.
+
 ```csharp
 public override DbConnection CreateConnection()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateConnectionStringBuilder.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateConnectionStringBuilder.md
@@ -4,6 +4,8 @@ title: CreateConnectionStringBuilder
 
 # MySqlConnectorFactory.CreateConnectionStringBuilder method
 
+Creates a new [`MySqlConnectionStringBuilder`](../../MySqlConnectionStringBuilderType/) object.
+
 ```csharp
 public override DbConnectionStringBuilder CreateConnectionStringBuilder()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateDataAdapter.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateDataAdapter.md
@@ -4,6 +4,8 @@ title: CreateDataAdapter
 
 # MySqlConnectorFactory.CreateDataAdapter method
 
+Creates a new [`MySqlDataAdapter`](../../MySqlDataAdapterType/) object.
+
 ```csharp
 public override DbDataAdapter CreateDataAdapter()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateParameter.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/CreateParameter.md
@@ -4,6 +4,8 @@ title: CreateParameter
 
 # MySqlConnectorFactory.CreateParameter method
 
+Creates a new [`MySqlParameter`](../../MySqlParameterType/) object.
+
 ```csharp
 public override DbParameter CreateParameter()
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactory/Instance.md b/docs/content/api/MySqlConnector/MySqlConnectorFactory/Instance.md
@@ -4,6 +4,8 @@ title: Instance
 
 # MySqlConnectorFactory.Instance field
 
+Provides an instance of DbProviderFactory that can create MySqlConnector objects.
+
 ```csharp
 public static readonly MySqlConnectorFactory Instance;
 ```
diff --git a/docs/content/api/MySqlConnector/MySqlConnectorFactoryType.md b/docs/content/api/MySqlConnector/MySqlConnectorFactoryType.md
@@ -4,6 +4,8 @@ title: MySqlConnectorFactory
 
 # MySqlConnectorFactory class
 
+An implementation of DbProviderFactory that creates MySqlConnector objects.
+
 ```csharp
 public sealed class MySqlConnectorFactory : DbProviderFactory
 ```
@@ -12,16 +14,19 @@ public sealed class MySqlConnectorFactory : DbProviderFactory
 
 | name | description |
 | --- | --- |
-| static readonly [Instance](../MySqlConnectorFactory/Instance/) |  |
-| [CanCreateBatch](../MySqlConnectorFactory/CanCreateBatch/) { get; } |  |
-| [CreateBatch](../MySqlConnectorFactory/CreateBatch/)() |  |
-| [CreateBatchCommand](../MySqlConnectorFactory/CreateBatchCommand/)() |  |
-| override [CreateCommand](../MySqlConnectorFactory/CreateCommand/)() |  |
-| override [CreateCommandBuilder](../MySqlConnectorFactory/CreateCommandBuilder/)() |  |
-| override [CreateConnection](../MySqlConnectorFactory/CreateConnection/)() |  |
-| override [CreateConnectionStringBuilder](../MySqlConnectorFactory/CreateConnectionStringBuilder/)() |  |
-| override [CreateDataAdapter](../MySqlConnectorFactory/CreateDataAdapter/)() |  |
-| override [CreateParameter](../MySqlConnectorFactory/CreateParameter/)() |  |
+| static readonly [Instance](../MySqlConnectorFactory/Instance/) | Provides an instance of DbProviderFactory that can create MySqlConnector objects. |
+| [CanCreateBatch](../MySqlConnectorFactory/CanCreateBatch/) { get; } | Returns `true`. |
+| override [CanCreateCommandBuilder](../MySqlConnectorFactory/CanCreateCommandBuilder/) { get; } | Returns `true`. |
+| override [CanCreateDataAdapter](../MySqlConnectorFactory/CanCreateDataAdapter/) { get; } | Returns `true`. |
+| override [CanCreateDataSourceEnumerator](../MySqlConnectorFactory/CanCreateDataSourceEnumerator/) { get; } | Returns `false`. |
+| [CreateBatch](../MySqlConnectorFactory/CreateBatch/)() | Creates a new [`MySqlBatch`](../MySqlBatchType/) object. |
+| [CreateBatchCommand](../MySqlConnectorFactory/CreateBatchCommand/)() | Creates a new [`MySqlBatchCommand`](../MySqlBatchCommandType/) object. |
+| override [CreateCommand](../MySqlConnectorFactory/CreateCommand/)() | Creates a new [`MySqlCommand`](../MySqlCommandType/) object. |
+| override [CreateCommandBuilder](../MySqlConnectorFactory/CreateCommandBuilder/)() | Creates a new [`MySqlCommandBuilder`](../MySqlCommandBuilderType/) object. |
+| override [CreateConnection](../MySqlConnectorFactory/CreateConnection/)() | Creates a new [`MySqlConnection`](../MySqlConnectionType/) object. |
+| override [CreateConnectionStringBuilder](../MySqlConnectorFactory/CreateConnectionStringBuilder/)() | Creates a new [`MySqlConnectionStringBuilder`](../MySqlConnectionStringBuilderType/) object. |
+| override [CreateDataAdapter](../MySqlConnectorFactory/CreateDataAdapter/)() | Creates a new [`MySqlDataAdapter`](../MySqlDataAdapterType/) object. |
+| override [CreateParameter](../MySqlConnectorFactory/CreateParameter/)() | Creates a new [`MySqlParameter`](../MySqlParameterType/) object. |
 
 ## See Also
 
diff --git a/docs/content/api/MySqlConnectorAssembly.md b/docs/content/api/MySqlConnectorAssembly.md
@@ -22,7 +22,7 @@ title: MySqlConnector
 | class [MySqlConnection](../MySqlConnector/MySqlConnectionType/) | [`MySqlConnection`](../MySqlConnector/MySqlConnectionType/) represents a connection to a MySQL database. |
 | enum [MySqlConnectionProtocol](../MySqlConnector/MySqlConnectionProtocolType/) | Specifies the type of connection to make to the server. |
 | class [MySqlConnectionStringBuilder](../MySqlConnector/MySqlConnectionStringBuilderType/) |  |
-| class [MySqlConnectorFactory](../MySqlConnector/MySqlConnectorFactoryType/) |  |
+| class [MySqlConnectorFactory](../MySqlConnector/MySqlConnectorFactoryType/) | An implementation of DbProviderFactory that creates MySqlConnector objects. |
 | class [MySqlConversionException](../MySqlConnector/MySqlConversionExceptionType/) |  |
 | class [MySqlDataAdapter](../MySqlConnector/MySqlDataAdapterType/) |  |
 | class [MySqlDataReader](../MySqlConnector/MySqlDataReaderType/) |  |
diff --git a/docs/content/api/MySqlConnectorNamespace.md b/docs/content/api/MySqlConnectorNamespace.md
@@ -20,7 +20,7 @@ title: MySqlConnector
 | class [MySqlConnection](../MySqlConnector/MySqlConnectionType/) | [`MySqlConnection`](../MySqlConnector/MySqlConnectionType/) represents a connection to a MySQL database. |
 | enum [MySqlConnectionProtocol](../MySqlConnector/MySqlConnectionProtocolType/) | Specifies the type of connection to make to the server. |
 | class [MySqlConnectionStringBuilder](../MySqlConnector/MySqlConnectionStringBuilderType/) |  |
-| class [MySqlConnectorFactory](../MySqlConnector/MySqlConnectorFactoryType/) |  |
+| class [MySqlConnectorFactory](../MySqlConnector/MySqlConnectorFactoryType/) | An implementation of DbProviderFactory that creates MySqlConnector objects. |
 | class [MySqlConversionException](../MySqlConnector/MySqlConversionExceptionType/) |  |
 | class [MySqlDataAdapter](../MySqlConnector/MySqlDataAdapterType/) |  |
 | class [MySqlDataReader](../MySqlConnector/MySqlDataReaderType/) |  |
diff --git a/src/MySqlConnector/MySqlConnectorFactory.cs b/src/MySqlConnector/MySqlConnectorFactory.cs
@@ -2,28 +2,80 @@
 
 namespace MySqlConnector
 {
+	/// <summary>
+	/// An implementation of <see cref="DbProviderFactory"/> that creates MySqlConnector objects.
+	/// </summary>
 	public sealed class MySqlConnectorFactory : DbProviderFactory
 	{
+		/// <summary>
+		/// Provides an instance of <see cref="DbProviderFactory"/> that can create MySqlConnector objects.
+		/// </summary>
 		public static readonly MySqlConnectorFactory Instance = new();
 
+		/// <summary>
+		/// Creates a new <see cref="MySqlCommand"/> object.
+		/// </summary>
 		public override DbCommand CreateCommand() => new MySqlCommand();
+
+		/// <summary>
+		/// Creates a new <see cref="MySqlConnection"/> object.
+		/// </summary>
 		public override DbConnection CreateConnection() => new MySqlConnection();
+
+		/// <summary>
+		/// Creates a new <see cref="MySqlConnectionStringBuilder"/> object.
+		/// </summary>
 		public override DbConnectionStringBuilder CreateConnectionStringBuilder() => new MySqlConnectionStringBuilder();
+
+		/// <summary>
+		/// Creates a new <see cref="MySqlParameter"/> object.
+		/// </summary>
+		/// <returns></returns>
 		public override DbParameter CreateParameter() => new MySqlParameter();
 
 #if !NETSTANDARD1_3
+		/// <summary>
+		/// Creates a new <see cref="MySqlCommandBuilder"/> object.
+		/// </summary>
 		public override DbCommandBuilder CreateCommandBuilder() => new MySqlCommandBuilder();
+
+		/// <summary>
+		/// Creates a new <see cref="MySqlDataAdapter"/> object.
+		/// </summary>
 		public override DbDataAdapter CreateDataAdapter() => new MySqlDataAdapter();
+
+		/// <summary>
+		/// Returns <c>false</c>.
+		/// </summary>
+		/// <remarks><see cref="DbDataSourceEnumerator"/> is not supported by MySqlConnector.</remarks>
 		public override bool CanCreateDataSourceEnumerator => false;
 
 #if !NET45 && !NET461 && !NET471 && !NETSTANDARD2_0 && !NETCOREAPP2_1
+		/// <summary>
+		/// Returns <c>true</c>.
+		/// </summary>
 		public override bool CanCreateCommandBuilder => true;
+
+		/// <summary>
+		/// Returns <c>true</c>.
+		/// </summary>
 		public override bool CanCreateDataAdapter => true;
 #endif
 #endif
 
+		/// <summary>
+		/// Creates a new <see cref="MySqlBatch"/> object.
+		/// </summary>
 		public MySqlBatch CreateBatch() => new MySqlBatch();
+
+		/// <summary>
+		/// Creates a new <see cref="MySqlBatchCommand"/> object.
+		/// </summary>
 		public MySqlBatchCommand CreateBatchCommand() => new MySqlBatchCommand();
+
+		/// <summary>
+		/// Returns <c>true</c>.
+		/// </summary>
 		public bool CanCreateBatch => true;
 
 		private MySqlConnectorFactory()
