Skip to content

Commit bf2bb3e

Browse files
carlossanlopcarlossanlop
authored
Automatic port of Microsoft.Extensions.Localization docs (#4930)
* Automatic port of Microsoft.Extensions.Localization docs * Apply suggestions from code review * Fix invalid references, including one missed from a previous PR. Co-authored-by: carlossanlop <[email protected]>
1 parent d54774e commit bf2bb3e

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

‎xml/Microsoft.Extensions.Localization/ResourceManagerStringLocalizer.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,9 @@
239239
<Parameter Name="includeParentCultures" Type="System.Boolean" />
240240
</Parameters>
241241
<Docs>
242-
<param name="includeParentCultures">To be added.</param>
243-
<summary>To be added.</summary>
244-
<returns>To be added.</returns>
242+
<param name="includeParentCultures"><see langword="true" /> to include strings from parent cultures; <see langword="false" /> otherwise.</param>
243+
<summary>Gets all the resource strings.</summary>
244+
<returns>An enumeration that contains all the resource strings.</returns>
245245
<remarks>To be added.</remarks>
246246
<inheritdoc />
247247
</Docs>
@@ -322,7 +322,7 @@
322322
<Docs>
323323
<param name="name">The name of the string resource.</param>
324324
<param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to get the string for.</param>
325-
<summary>Gets a resource string from the <see cref="F:Microsoft.Extensions.Localization.ResourceManagerStringLocalizer._resourceManager" /> and returns <see langword="null" /> instead of
325+
<summary>Gets a resource string from the resource manager and returns <see langword="null" /> instead of
326326
throwing exceptions if a match isn't found.</summary>
327327
<returns>The resource string, or <see langword="null" /> if none was found.</returns>
328328
<remarks>To be added.</remarks>
@@ -356,9 +356,9 @@
356356
<Parameter Name="name" Type="System.String" />
357357
</Parameters>
358358
<Docs>
359-
<param name="name">To be added.</param>
360-
<summary>To be added.</summary>
361-
<value>To be added.</value>
359+
<param name="name">The name of the string resource.</param>
360+
<summary>Gets the string resource with the given name.</summary>
361+
<value>The string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString" />.</value>
362362
<remarks>To be added.</remarks>
363363
<inheritdoc />
364364
</Docs>
@@ -399,10 +399,10 @@
399399
</Parameter>
400400
</Parameters>
401401
<Docs>
402-
<param name="name">To be added.</param>
403-
<param name="arguments">To be added.</param>
404-
<summary>To be added.</summary>
405-
<value>To be added.</value>
402+
<param name="name">The name of the string resource.</param>
403+
<param name="arguments">The values to format the string with.</param>
404+
<summary>Gets the string resource with the given name and formatted with the supplied arguments.</summary>
405+
<value>The formatted string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString" />.</value>
406406
<remarks>To be added.</remarks>
407407
<inheritdoc />
408408
</Docs>

‎xml/Microsoft.Extensions.Localization/ResourceNamesCache.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@
8080
<Parameter Name="valueFactory" Type="System.Func&lt;System.String,System.Collections.Generic.IList&lt;System.String&gt;&gt;" />
8181
</Parameters>
8282
<Docs>
83-
<param name="name">To be added.</param>
84-
<param name="valueFactory">To be added.</param>
85-
<summary>To be added.</summary>
86-
<returns>To be added.</returns>
83+
<param name="name">The resource name to add string names for.</param>
84+
<param name="valueFactory">The function used to generate the string names for the resource.</param>
85+
<summary>Adds a set of resource names to the cache by using the specified function, if the name does not already exist.</summary>
86+
<returns>A list containing the string names for the resource.</returns>
8787
<remarks>To be added.</remarks>
8888
<inheritdoc />
8989
</Docs>

‎xml/Microsoft.Extensions.Localization/StringLocalizer`1.xml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@
9191
<Parameter Name="includeParentCultures" Type="System.Boolean" />
9292
</Parameters>
9393
<Docs>
94-
<param name="includeParentCultures">To be added.</param>
95-
<summary>To be added.</summary>
96-
<returns>To be added.</returns>
94+
<param name="includeParentCultures"><see langword="true" /> to include strings from parent cultures; <see langword="false" /> otherwise.</param>
95+
<summary>Gets all the resource strings.</summary>
96+
<returns>An enumeration that contains all the resource strings.</returns>
9797
<remarks>To be added.</remarks>
9898
<inheritdoc />
9999
</Docs>
@@ -126,9 +126,9 @@
126126
<Parameter Name="name" Type="System.String" />
127127
</Parameters>
128128
<Docs>
129-
<param name="name">To be added.</param>
130-
<summary>To be added.</summary>
131-
<value>To be added.</value>
129+
<param name="name">The name of the string resource.</param>
130+
<summary>Gets the string resource with the given name.</summary>
131+
<value>The string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString" />.</value>
132132
<remarks>To be added.</remarks>
133133
<inheritdoc />
134134
</Docs>
@@ -169,10 +169,10 @@
169169
</Parameter>
170170
</Parameters>
171171
<Docs>
172-
<param name="name">To be added.</param>
173-
<param name="arguments">To be added.</param>
174-
<summary>To be added.</summary>
175-
<value>To be added.</value>
172+
<param name="name">The name of the string resource.</param>
173+
<param name="arguments">The values to format the string with.</param>
174+
<summary>Gets the string resource with the given name and formatted with the supplied arguments.</summary>
175+
<value>The formatted string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString" />.</value>
176176
<remarks>To be added.</remarks>
177177
<inheritdoc />
178178
</Docs>
@@ -211,9 +211,9 @@
211211
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
212212
</Parameters>
213213
<Docs>
214-
<param name="culture">To be added.</param>
215-
<summary>To be added.</summary>
216-
<returns>To be added.</returns>
214+
<param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use.</param>
215+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer" /> for a specific <see cref="T:System.Globalization.CultureInfo" />.</summary>
216+
<returns>A culture-specific <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer" />.</returns>
217217
<remarks>To be added.</remarks>
218218
<inheritdoc />
219219
</Docs>

‎xml/Microsoft.Extensions.Logging.AzureAppServices/BatchingLoggerProvider.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
</Interface>
2626
</Interfaces>
2727
<Docs>
28-
<summary>A provider of <see cref="T:Microsoft.Extensions.Logging.AzureAppServices.BatchingLogger" /> instances.</summary>
28+
<summary>A provider of <see cref="T:Microsoft.Extensions.Logging.AzureAppServices.Internal.BatchingLogger" /> instances.</summary>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
<Members>

0 commit comments

Comments
 (0)