diff --git a/src/Microsoft.PowerShell.Commands.Diagnostics/GetEventCommand.cs b/src/Microsoft.PowerShell.Commands.Diagnostics/GetEventCommand.cs
index f8dfa499a7..e6e2ad81df 100644
--- a/src/Microsoft.PowerShell.Commands.Diagnostics/GetEventCommand.cs
+++ b/src/Microsoft.PowerShell.Commands.Diagnostics/GetEventCommand.cs
@@ -27,9 +27,9 @@ namespace Microsoft.PowerShell.Commands
[Cmdlet(VerbsCommon.Get, "WinEvent" , DefaultParameterSetName = "GetLogSet", HelpUri = "http://go.microsoft.com/fwlink/?LinkID=138336")]
public sealed class GetWinEventCommand : PSCmdlet
{
- //
- // ListLog parameter
- //
+ ///
+ /// ListLog parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -51,9 +51,9 @@ namespace Microsoft.PowerShell.Commands
}
private string[] _listLog = {"*"};
- //
- // GetLog parameter
- //
+ ///
+ /// GetLog parameter
+ ///
[Parameter(
Position = 0,
ParameterSetName="GetLogSet",
@@ -73,9 +73,9 @@ namespace Microsoft.PowerShell.Commands
private string[] _logName = {"*"};
- //
- // ListProvider parameter
- //
+ ///
+ /// ListProvider parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -99,9 +99,9 @@ namespace Microsoft.PowerShell.Commands
private string[] _listProvider = {"*"};
- //
- // ProviderName parameter
- //
+ ///
+ /// ProviderName parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -123,9 +123,9 @@ namespace Microsoft.PowerShell.Commands
private string[] _providerName;
- //
- // Path parameter
- //
+ ///
+ /// Path parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -147,9 +147,9 @@ namespace Microsoft.PowerShell.Commands
private string[] _path;
- //
- // MaxEvents parameter
- //
+ ///
+ /// MaxEvents parameter
+ ///
[Parameter(
ParameterSetName="FileSet",
ValueFromPipeline = false,
@@ -188,9 +188,9 @@ namespace Microsoft.PowerShell.Commands
}
private Int64 _maxEvents = -1;
- //
- // ComputerName parameter
- //
+ ///
+ /// ComputerName parameter
+ ///
[Parameter(
ParameterSetName="ListProviderSet",
HelpMessageBaseName = "GetEventResources",
@@ -225,9 +225,9 @@ namespace Microsoft.PowerShell.Commands
}
private string _computerName = string.Empty;
- //
- // Credential parameter
- //
+ ///
+ /// Credential parameter
+ ///
[Parameter(ParameterSetName="ListProviderSet")]
[Parameter(ParameterSetName="GetProviderSet")]
[Parameter(ParameterSetName="ListLogSet")]
@@ -244,9 +244,9 @@ namespace Microsoft.PowerShell.Commands
private PSCredential _credential = PSCredential.Empty;
- //
- // FilterXPath parameter
- //
+ ///
+ /// FilterXPath parameter
+ ///
[Parameter(
ParameterSetName="FileSet",
ValueFromPipeline = false,
@@ -270,9 +270,9 @@ namespace Microsoft.PowerShell.Commands
}
private string _filter = "*";
- //
- // FilterXml parameter
- //
+ ///
+ /// FilterXml parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -294,9 +294,9 @@ namespace Microsoft.PowerShell.Commands
private XmlDocument _xmlQuery = null;
- //
- // FilterHashtable parameter
- //
+ ///
+ /// FilterHashtable parameter
+ ///
[Parameter(
Position = 0,
Mandatory = true,
@@ -317,9 +317,9 @@ namespace Microsoft.PowerShell.Commands
}
private Hashtable[] _selector;
- //
- // Force switch
- //
+ ///
+ /// Force switch
+ ///
[Parameter(ParameterSetName="ListLogSet")]
[Parameter(ParameterSetName="GetProviderSet")]
[Parameter(ParameterSetName="GetLogSet")]
@@ -332,9 +332,9 @@ namespace Microsoft.PowerShell.Commands
}
private SwitchParameter _force;
- //
- // Oldest switch
- //
+ ///
+ /// Oldest switch
+ ///
[Parameter(ParameterSetName="FileSet")]
[Parameter(ParameterSetName="GetProviderSet")]
[Parameter(ParameterSetName="GetLogSet")]
@@ -391,18 +391,18 @@ namespace Microsoft.PowerShell.Commands
private const string hashkey_data_lc="data";
- //
- // BeginProcessing() is invoked once per pipeline: we will load System.Core.dll here
- //
+ ///
+ /// BeginProcessing() is invoked once per pipeline: we will load System.Core.dll here
+ ///
protected override void BeginProcessing()
{
_resourceMgr = Microsoft.PowerShell.Commands.Diagnostics.Common.CommonUtilities.GetResourceManager();
}
- //
- // EndProcessing() is invoked once per pipeline
- //
+ ///
+ /// EndProcessing() is invoked once per pipeline
+ ///
protected override void EndProcessing()
{
@@ -426,10 +426,10 @@ namespace Microsoft.PowerShell.Commands
}
- //
- // ProcessRecord() override.
- // This is the main entry point for the cmdlet.
- //
+ ///
+ /// ProcessRecord() override.
+ /// This is the main entry point for the cmdlet.
+ ///
protected override void ProcessRecord()
{
switch (ParameterSetName)
diff --git a/src/Microsoft.PowerShell.Commands.Diagnostics/PdhHelper.cs b/src/Microsoft.PowerShell.Commands.Diagnostics/PdhHelper.cs
index 208932dc6f..4e8697f223 100644
--- a/src/Microsoft.PowerShell.Commands.Diagnostics/PdhHelper.cs
+++ b/src/Microsoft.PowerShell.Commands.Diagnostics/PdhHelper.cs
@@ -479,6 +479,7 @@ namespace Microsoft.Powershell.Commands.GetCounter.PdhNative
/// A helper reading in a Unicode string with embedded NULLs and splitting it into a StringCollection.
///
///
+ ///
///
private void ReadPdhMultiString(ref IntPtr strNative, Int32 strSize, ref StringCollection strColl)
diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs
index b839e4df38..2bf94a4004 100644
--- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs
+++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs
@@ -156,7 +156,7 @@ namespace Microsoft.PowerShell.Commands
/// Returns the base name of the file containing the matching line.
///
/// It will be the string "InputStream" if the object came from the input stream.
- /// This is a readonly propery calculated from .
+ /// This is a readonly property calculated from the path.
///
///
/// The file name
diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Send-MailMessage.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Send-MailMessage.cs
index 1e691675d4..6584be9c62 100644
--- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Send-MailMessage.cs
+++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Send-MailMessage.cs
@@ -261,7 +261,7 @@ namespace Microsoft.PowerShell.Commands
private SwitchParameter usessl;
///
- /// Specifies the Port to be used on
+ /// Specifies the Port to be used on the server.
///
///
/// Value must be greater than zero.
diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/sort-object.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/sort-object.cs
index cb06e8191d..afa1ce46ad 100644
--- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/sort-object.cs
+++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/sort-object.cs
@@ -23,7 +23,7 @@ namespace Microsoft.PowerShell.Commands
set { DescendingOrder = value; }
}
///
- ///
+ /// This param specifies if only unique objects are filtered.
///
///
[Parameter]
@@ -37,7 +37,7 @@ namespace Microsoft.PowerShell.Commands
///
- /// Remove Duplicated from
+ /// Remove duplicates.
///
private static void RemoveDuplicates(OrderByProperty orderByProperty)
{
diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs
index e8363a6c8e..3afd1b769a 100644
--- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs
+++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs
@@ -286,14 +286,12 @@ namespace Microsoft.PowerShell
- ///
- ///
- /// The break handler for the program. Dispatches a break event to the current Executor.
- ///
- ///
- ///
- ///
#if LINUX
+ ///
+ ///
+ /// The break handler for the program. Dispatches a break event to the current Executor.
+ ///
+ ///
private static void MyBreakHandler(object sender, ConsoleCancelEventArgs args)
{
// Set the Cancel property to true to prevent the process from terminating.
@@ -310,6 +308,13 @@ namespace Microsoft.PowerShell
}
}
#else
+ ///
+ ///
+ /// The break handler for the program. Dispatches a break event to the current Executor.
+ ///
+ ///
+ ///
+ ///
private static bool MyBreakHandler(ConsoleControl.ConsoleBreakSignal signal)
{
switch (signal)
diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
index 9984e0a60b..14bf57e1c3 100644
--- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
+++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
@@ -1978,12 +1978,12 @@ namespace Microsoft.PowerShell
#endif
}
+#if !LINUX
///
/// Get the character at the cursor when the user types 'tab' in the middle of line.
///
/// the cursor position where 'tab' is hit
///
-#if !LINUX
private char GetCharacterUnderCursor(Coordinates cursorPosition)
{
Rectangle region = new Rectangle(0, cursorPosition.Y, RawUI.BufferSize.Width - 1, cursorPosition.Y);
diff --git a/src/Microsoft.PowerShell.PSReadLine/ReadLine.cs b/src/Microsoft.PowerShell.PSReadLine/ReadLine.cs
index 75654e21d1..3601670c7e 100644
--- a/src/Microsoft.PowerShell.PSReadLine/ReadLine.cs
+++ b/src/Microsoft.PowerShell.PSReadLine/ReadLine.cs
@@ -876,6 +876,11 @@ namespace Microsoft.PowerShell
_singleton.Render();
}
+ ///
+ /// Gets the current prompt as possibly defined by the user through the
+ /// prompt function, and returns a default prompt if no other is
+ /// available. Also handles remote prompts.
+ ///
public static string GetPrompt()
{
var runspaceIsRemote = _singleton._mockableMethods.RunspaceIsRemote(_singleton._runspace);
diff --git a/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs b/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs
index e4a8701b6e..7ce0a44196 100644
--- a/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs
+++ b/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs
@@ -31,7 +31,9 @@ namespace System.Management.Automation
public static class Platform
{
- // Platform variables used to defined corresponding PowerShell built-in variables
+ ///
+ /// True if the current platform is Linux.
+ ///
public static bool IsLinux
{
get
@@ -44,21 +46,9 @@ namespace System.Management.Automation
}
}
- //enum for selecting the xdgpaths
- public enum XDG_Type
- {
- // location to store configuration file
- CONFIG,
- // location for powershell modules
- MODULES,
- // location to store temporary files
- CACHE,
- // location to store data that application needs
- DATA,
- // default location
- DEFAULT
- }
-
+ ///
+ /// True if the current platform is OS X.
+ ///
public static bool IsOSX
{
get
@@ -71,6 +61,9 @@ namespace System.Management.Automation
}
}
+ ///
+ /// True if the current platform is Windows.
+ ///
public static bool IsWindows
{
get
@@ -83,6 +76,9 @@ namespace System.Management.Automation
}
}
+ ///
+ /// True if PowerShell was built targeting .NET Core.
+ ///
public static bool IsCore
{
get
@@ -111,7 +107,26 @@ namespace System.Management.Automation
"WSMan.format.ps1xml"
};
- // function for choosing directory location of PowerShell for profile loading
+ ///
+ /// X Desktop Group configuration type enum.
+ ///
+ public enum XDG_Type
+ {
+ /// XDG_CONFIG_HOME/powershell
+ CONFIG,
+ /// XDG_CACHE_HOME/powershell
+ CACHE,
+ /// XDG_DATA_HOME/powershell
+ DATA,
+ /// XDG_DATA_HOME/powershell/Modules
+ MODULES,
+ /// XDG_CONFIG_HOME/powershell
+ DEFAULT
+ }
+
+ ///
+ /// function for choosing directory location of PowerShell for profile loading
+ ///
public static string SelectProductNameForDirectory (Platform.XDG_Type dirpath)
{
@@ -356,7 +371,7 @@ namespace System.Management.Automation
///
/// This models the native call CommandLineToArgvW in managed code.
///
- public static string[] CommandLineToArgv(string command)
+ internal static string[] CommandLineToArgv(string command)
{
StringBuilder arguments = new StringBuilder();
int len = command.Length;
diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs
index 68e49038cd..b2143f8f60 100644
--- a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs
+++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs
@@ -627,7 +627,7 @@ namespace System.Management.Automation.Remoting
///
/// Operation shutdown notification that was registered with the native layer for each of the shellCreate operations.
///
- /// IntPtr
+ /// IntPtr
public static void WSManPSShutdown(
IntPtr shutdownContext)
{