Skip to content

Commit 7728574

Browse files
rojimairaw
authored andcommitted
Add missing documentation for DbProviderFactories APIs (#3401)
* Add missing documentation for DbProviderFactories APIs Introduced in https://github.com/dotnet/corefx/issues/20903 * minor fixes
1 parent ed10ee0 commit 7728574

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

xml/System.Data.Common/DbProviderFactories.xml

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,8 @@
251251
</ReturnValue>
252252
<Parameters />
253253
<Docs>
254-
<summary>To be added.</summary>
255-
<returns>To be added.</returns>
254+
<summary>Returns the invariant provider names for all registered instances of <see cref="T:System.Data.Common.DbProviderFactory" />.</summary>
255+
<returns>The invariant provider names for all registered instances of <see cref="T:System.Data.Common.DbProviderFactory" />.</returns>
256256
<remarks>To be added.</remarks>
257257
</Docs>
258258
</Member>
@@ -283,10 +283,10 @@
283283
<Parameter Name="factory" Type="System.Data.Common.DbProviderFactory" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
284284
</Parameters>
285285
<Docs>
286-
<param name="providerInvariantName">To be added.</param>
287-
<param name="factory">To be added.</param>
288-
<summary>To be added.</summary>
289-
<remarks>To be added.</remarks>
286+
<param name="providerInvariantName">The invariant provider name under which to register the provider.</param>
287+
<param name="factory">The instance of the provider factory to be registered.</param>
288+
<summary>Registers an instance of <see cref="T:System.Data.Common.DbProviderFactory" /> under the specified invariant provider name.</summary>
289+
<remarks>If a provider is already registered under <paramref name="providerInvariantName" />, that registration will be overwritten.</remarks>
290290
</Docs>
291291
</Member>
292292
<Member MemberName="RegisterFactory">
@@ -316,10 +316,10 @@
316316
<Parameter Name="factoryTypeAssemblyQualifiedName" Type="System.String" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
317317
</Parameters>
318318
<Docs>
319-
<param name="providerInvariantName">To be added.</param>
320-
<param name="factoryTypeAssemblyQualifiedName">To be added.</param>
321-
<summary>To be added.</summary>
322-
<remarks>To be added.</remarks>
319+
<param name="providerInvariantName">The invariant provider name under which to register the provider.</param>
320+
<param name="factoryTypeAssemblyQualifiedName">The assembly-qualified name for a <see cref="T:System.Data.Common.DbProviderFactory" />.</param>
321+
<summary>Registers a <see cref="T:System.Data.Common.DbProviderFactory" /> with the given assembly-qualified name under the specified invariant provider name.</summary>
322+
<remarks>If a provider is already registered under <paramref name="providerInvariantName" />, that registration will be overwritten.</remarks>
323323
</Docs>
324324
</Member>
325325
<Member MemberName="RegisterFactory">
@@ -349,10 +349,10 @@
349349
<Parameter Name="providerFactoryClass" Type="System.Type" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
350350
</Parameters>
351351
<Docs>
352-
<param name="providerInvariantName">To be added.</param>
353-
<param name="providerFactoryClass">To be added.</param>
354-
<summary>To be added.</summary>
355-
<remarks>To be added.</remarks>
352+
<param name="providerInvariantName">The invariant provider name under which to register the provider.</param>
353+
<param name="providerFactoryClass">The type representing a <see cref="T:System.Data.Common.DbProviderFactory" />.</param>
354+
<summary>Registers a <see cref="T:System.Data.Common.DbProviderFactory" /> with the given type under the specified invariant provider name.</summary>
355+
<remarks>If a provider is already registered under <paramref name="providerInvariantName" />, that registration will be overwritten.</remarks>
356356
</Docs>
357357
</Member>
358358
<Member MemberName="TryGetFactory">
@@ -382,10 +382,11 @@
382382
<Parameter Name="factory" Type="System.Data.Common.DbProviderFactory" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
383383
</Parameters>
384384
<Docs>
385-
<param name="providerInvariantName">To be added.</param>
386-
<param name="factory">To be added.</param>
387-
<summary>To be added.</summary>
388-
<returns>To be added.</returns>
385+
<param name="providerInvariantName">The invariant provider name to look up.</param>
386+
<param name="factory">When this method returns, contains the <see cref="T:System.Data.Common.DbProviderFactory" /> associated with the specified invariant provider name, if the name is found; otherwise, <see langword="null" />. This parameter is passed uninitialized.</param>
387+
<summary>Attempts to get the <see cref="T:System.Data.Common.DbProviderFactory" /> registered under the specified invariant provider name.</summary>
388+
<returns>
389+
<see langword="true" /> if a provider is registered under the specified invariant provider name; otherwise, <see langword="false" />.</returns>
389390
<remarks>To be added.</remarks>
390391
</Docs>
391392
</Member>
@@ -415,9 +416,10 @@
415416
<Parameter Name="providerInvariantName" Type="System.String" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
416417
</Parameters>
417418
<Docs>
418-
<param name="providerInvariantName">To be added.</param>
419-
<summary>To be added.</summary>
420-
<returns>To be added.</returns>
419+
<param name="providerInvariantName">The invariant provider name of the registration to remove.</param>
420+
<summary>Removes a <see cref="T:System.Data.Common.DbProviderFactory" /> registration for the given provider invariant name.</summary>
421+
<returns>
422+
<see langword="true" /> if the registration is successfully found and removed; otherwise, <see langword="false" />. This method returns <see langword="false" /> if a registration for <paramref name="providerInvariantName" /> is not found.</returns>
421423
<remarks>To be added.</remarks>
422424
</Docs>
423425
</Member>

0 commit comments

Comments
 (0)