From 2c4257eeb68e7778edfafabdc98864f6dd2ed3be Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 28 Nov 2017 05:53:46 +0000 Subject: [PATCH] XML documentation fix for CompletionResult (#5550) * XML documentation fix for CompletionResult: 1 typo, make text start with upper case and add periods at the end. This typo showed up on the official docs site: https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.completionresult.-ctor?view=powershellsdk-1.1.0#System_Management_Automation_CompletionResult__ctor_System_String_ * Add periods to private members as well as suggested in PR. --- .../CommandCompletion/CompletionResult.cs | 66 +++++++++---------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/src/System.Management.Automation/engine/CommandCompletion/CompletionResult.cs b/src/System.Management.Automation/engine/CommandCompletion/CompletionResult.cs index fd9cf08a69..2109c6b2d0 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CompletionResult.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CompletionResult.cs @@ -12,50 +12,50 @@ namespace System.Management.Automation using System; /// - /// Possible types of CompletionResults + /// Possible types of CompletionResults. /// public enum CompletionResultType { - /// An unknown result type, kept as text only + /// An unknown result type, kept as text only. Text = 0, - /// A history result type like the items out of get-history + /// A history result type like the items out of get-history. History = 1, - /// A command result type like the items out of get-command + /// A command result type like the items out of get-command. Command = 2, - /// A provider item + /// A provider item. ProviderItem = 3, - /// A provider container + /// A provider container. ProviderContainer = 4, - /// A property result type like the property items out of get-member + /// A property result type like the property items out of get-member. Property = 5, - /// A method result type like the method items out of get-member + /// A method result type like the method items out of get-member. Method = 6, - /// A parameter name result type like the Parameters property out of get-command items + /// A parameter name result type like the Parameters property out of get-command items. ParameterName = 7, - /// A parameter value result type + /// A parameter value result type. ParameterValue = 8, - /// A variable result type like the items out of get-childitem variable: + /// A variable result type like the items out of get-childitem variable. Variable = 9, - /// A namespace + /// A namespace. Namespace = 10, - /// A type name + /// A type name. Type = 11, - /// A keyword + /// A keyword. Keyword = 12, - /// A dynamic keyword + /// A dynamic keyword. DynamicKeyword = 13, // If a new enum is added, there is a range test that uses DynamicKeyword for parameter validation @@ -64,37 +64,37 @@ namespace System.Management.Automation } /// - /// Class used to store a tab completion or Intellisense result + /// Class used to store a tab completion or Intellisense result. /// public class CompletionResult { /// - /// Text to be used as the auto completion result + /// Text to be used as the auto completion result. /// private string _completionText; /// - /// Text to be displayed in a list + /// Text to be displayed in a list. /// private string _listItemText; /// - /// The text for the tooltip with details to be displayed about the object + /// The text for the tooltip with details to be displayed about the object. /// private string _toolTip; /// - /// Type of completion result + /// Type of completion result. /// private CompletionResultType _resultType; /// - /// Private member for null instance + /// Private member for null instance. /// private static readonly CompletionResult s_nullInstance = new CompletionResult(); /// - /// Gets the text to be used as the auto completion result + /// Gets the text to be used as the auto completion result. /// public string CompletionText { @@ -109,7 +109,7 @@ namespace System.Management.Automation } /// - /// Gets the text to be displayed in a list + /// Gets the text to be displayed in a list. /// public string ListItemText { @@ -124,7 +124,7 @@ namespace System.Management.Automation } /// - /// Gets the type of completion result + /// Gets the type of completion result. /// public CompletionResultType ResultType { @@ -139,7 +139,7 @@ namespace System.Management.Automation } /// - /// Gets the text for the tooltip with details to be displayed about the object + /// Gets the text for the tooltip with details to be displayed about the object. /// public string ToolTip { @@ -154,7 +154,7 @@ namespace System.Management.Automation } /// - /// Gets the null instance of type CompletionResult + /// Gets the null instance of type CompletionResult. /// internal static CompletionResult Null { @@ -162,12 +162,12 @@ namespace System.Management.Automation } /// - /// Initializes a new instance of the CompletionResult class + /// Initializes a new instance of the CompletionResult class. /// - /// the text to be used as the auto completion result - /// he text to be displayed in a list - /// the type of completion result - /// the text for the tooltip with details to be displayed about the object + /// The text to be used as the auto completion result. + /// The text to be displayed in a list. + /// The type of completion result. + /// The text for the tooltip with details to be displayed about the object. public CompletionResult(string completionText, string listItemText, CompletionResultType resultType, string toolTip) { if (String.IsNullOrEmpty(completionText)) @@ -198,9 +198,9 @@ namespace System.Management.Automation /// - /// Initializes a new instance of this class internally if the result out of TabExpansion is a string + /// Initializes a new instance of this class internally if the result out of TabExpansion is a string. /// - /// completion text + /// Completion text. public CompletionResult(string completionText) : this(completionText, completionText, CompletionResultType.Text, completionText) {