From: Dan Moseley Date: Thu, 5 Aug 2021 16:27:25 +0000 (-0600) Subject: Update some XML doc comments per feedback (#56886) X-Git-Tag: accepted/tizen/unified/20220110.054933~621 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b69069588c452e62f6314785e4edfbdd2bc4e88d;p=platform%2Fupstream%2Fdotnet%2Fruntime.git Update some XML doc comments per feedback (#56886) * IndentedTextWriter * StringInfo * StringSegment * GHC * Remove HTML * feedback --- diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs index 9f5e509..f0f0031 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs @@ -173,17 +173,15 @@ namespace Microsoft.Extensions.Hosting /// /// /// The following defaults are applied to the : - /// - /// set the to the result of - /// load host from "DOTNET_" prefixed environment variables - /// load host from supplied command line args - /// load app from 'appsettings.json' and 'appsettings.[].json' - /// load app from User Secrets when is 'Development' using the entry assembly - /// load app from environment variables - /// load app from supplied command line args - /// configure the to log to the console, debug, and event source output - /// enables scope validation on the dependency injection container when is 'Development' - /// + /// * set the to the result of + /// * load host from "DOTNET_" prefixed environment variables + /// * load host from supplied command line args + /// * load app from 'appsettings.json' and 'appsettings.[].json' + /// * load app from User Secrets when is 'Development' using the entry assembly + /// * load app from environment variables + /// * load app from supplied command line args + /// * configure the to log to the console, debug, and event source output + /// * enables scope validation on the dependency injection container when is 'Development' /// /// The existing builder to configure. /// The command line args. diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs b/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs index f1cd6ca..c5a7027 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs @@ -183,7 +183,11 @@ namespace Microsoft.Extensions.Primitives } } - /// + /// + /// Indicates whether the current object is equal to another object of the same type. + /// + /// An object to compare with this object. + /// if the current object is equal to the other parameter; otherwise, . public override bool Equals(object obj) { return obj is StringSegment segment && Equals(segment); @@ -266,7 +270,12 @@ namespace Microsoft.Extensions.Primitives return AsSpan().Equals(text.AsSpan(), comparisonType); } - /// + /// + /// Returns a hash code for this instance. + /// + /// + /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public override int GetHashCode() { diff --git a/src/libraries/System.Private.CoreLib/src/System/CodeDom/Compiler/IndentedTextWriter.cs b/src/libraries/System.Private.CoreLib/src/System/CodeDom/Compiler/IndentedTextWriter.cs index a502674..58db6fa 100644 --- a/src/libraries/System.Private.CoreLib/src/System/CodeDom/Compiler/IndentedTextWriter.cs +++ b/src/libraries/System.Private.CoreLib/src/System/CodeDom/Compiler/IndentedTextWriter.cs @@ -193,10 +193,10 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified value to the underlying , inserting tabs at the + /// Asynchronously writes the specified string to the underlying , inserting tabs at the /// start of every line. /// - /// The value to write. + /// The string to write. /// A representing the asynchronous operation. public override async Task WriteAsync(string? value) { @@ -205,10 +205,10 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified buffer to the underlying , inserting tabs at the + /// Asynchronously writes the specified characters to the underlying , inserting tabs at the /// start of every line. /// - /// The buffer to write. + /// The characters to write. /// Token for canceling the operation. /// A representing the asynchronous operation. public override async Task WriteAsync(ReadOnlyMemory buffer, CancellationToken cancellationToken = default) @@ -218,10 +218,10 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified to the underlying , inserting tabs at the + /// Asynchronously writes the contents of the specified to the underlying , inserting tabs at the /// start of every line. /// - /// The value to write. + /// The text to write. /// Token for canceling the operation. /// A representing the asynchronous operation. public override async Task WriteAsync(StringBuilder? value, CancellationToken cancellationToken = default) @@ -236,9 +236,9 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified text to the underlying without inserting tabs. + /// Asynchronously writes the specified string to the underlying without inserting tabs. /// - /// The text to write. + /// The string to write. /// A representing the asynchronous operation. public Task WriteLineNoTabsAsync(string? s) { @@ -363,7 +363,7 @@ namespace System.CodeDom.Compiler /// Asynchronously writes the specified to the underlying followed by a line terminator, inserting tabs /// at the start of every line. /// - /// The value to write. + /// The character to write. /// A representing the asynchronous operation. public override async Task WriteLineAsync(char value) { @@ -376,7 +376,7 @@ namespace System.CodeDom.Compiler /// Asynchronously writes the specified number of characters from the specified buffer followed by a line terminator, /// to the underlying , starting at the specified index within the buffer, inserting tabs at the start of every line. /// - /// The buffer to write from. + /// The buffer containing characters to write. /// The index within the buffer to start writing at. /// The number of characters to write. /// A representing the asynchronous operation. @@ -388,10 +388,10 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified value followed by a line terminator to the underlying , inserting + /// Asynchronously writes the specified string followed by a line terminator to the underlying , inserting /// tabs at the start of every line. /// - /// The value to write. + /// The string to write. /// A representing the asynchronous operation. public override async Task WriteLineAsync(string? value) { @@ -401,10 +401,10 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified buffer followed by a line terminator to the underlying , inserting + /// Asynchronously writes the specified characters followed by a line terminator to the underlying , inserting /// tabs at the start of every line. /// - /// The buffer to write from. + /// The characters to write. /// Token for canceling the operation. /// A representing the asynchronous operation. public override async Task WriteLineAsync(ReadOnlyMemory buffer, CancellationToken cancellationToken = default) @@ -415,8 +415,8 @@ namespace System.CodeDom.Compiler } /// - /// Asynchronously writes the specified text followed by a line terminator to the underlying , inserting - /// tabs at the start of every line. + /// Asynchronously writes the contents of the specified followed by a line terminator to the + /// underlying , inserting tabs at the start of every line. /// /// The text to write. /// Token for canceling the operation. diff --git a/src/libraries/System.Private.CoreLib/src/System/Globalization/StringInfo.cs b/src/libraries/System.Private.CoreLib/src/System/Globalization/StringInfo.cs index fe9aee0..1e4c698 100644 --- a/src/libraries/System.Private.CoreLib/src/System/Globalization/StringInfo.cs +++ b/src/libraries/System.Private.CoreLib/src/System/Globalization/StringInfo.cs @@ -97,6 +97,9 @@ namespace System.Globalization /// /// Returns the first text element (extended grapheme cluster) that occurs in the input string. /// + /// + /// A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit. + /// /// The input string to analyze. /// The substring corresponding to the first text element within , /// or the empty string if is empty. @@ -107,6 +110,9 @@ namespace System.Globalization /// Returns the first text element (extended grapheme cluster) that occurs in the input string /// starting at the specified index. /// + /// + /// A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit. + /// /// The input string to analyze. /// The char offset in at which to begin analysis. /// The substring corresponding to the first text element within starting @@ -123,6 +129,9 @@ namespace System.Globalization /// /// Returns the length of the first text element (extended grapheme cluster) that occurs in the input string. /// + /// + /// A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit. + /// /// The input string to analyze. /// The length (in chars) of the substring corresponding to the first text element within , /// or 0 if is empty. @@ -133,6 +142,9 @@ namespace System.Globalization /// Returns the length of the first text element (extended grapheme cluster) that occurs in the input string /// starting at the specified index. /// + /// + /// A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit. + /// /// The input string to analyze. /// The char offset in at which to begin analysis. /// The length (in chars) of the substring corresponding to the first text element within starting @@ -156,6 +168,9 @@ namespace System.Globalization /// /// Returns the length of the first text element (extended grapheme cluster) that occurs in the input span. /// + /// + /// A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit. + /// /// The input span to analyze. /// The length (in chars) of the substring corresponding to the first text element within , /// or 0 if is empty.