admin/PowerShell-PowerShell
1
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell synced 2026-06-08 12:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Style: remove '<remarks> </remarks>' (#8538)

Browse Source
This commit is contained in:
Ilya
2018-12-26 08:03:57 +05:00
committed by GitHub
parent 871ce5696d
commit 399574430e
8 changed files with 6 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Microsoft.PowerShell.Security/security/CertificateProvider.cs
+2 -4
View File
@@ -2251,8 +2251,7 @@ namespace Microsoft.PowerShell.Commands
/// </param>
/// <param name="returnNames"> whether we only need the names </param>
/// <param name="filter"> filter info </param>
/// <returns>Does not return a value.</returns>
/// <remarks> </remarks>
/// <returns> Does not return a value.</returns>
private void GetChildItemsOrNames(
string path,
bool recurse,
@@ -2516,8 +2515,7 @@ namespace Microsoft.PowerShell.Commands
/// <param name="recurse"> recursively return all items if true </param>
/// <param name="returnNames"> </param>
/// <param name="filter"> filter info </param>
/// <returns>Does not return a value.</returns>
/// <remarks> </remarks>
/// <returns> Does not return a value.</returns>
private void GetStoresOrNames(
string path,
bool recurse,
src/Microsoft.PowerShell.Security/security/Utils.cs
+2 -10
View File
@@ -16,8 +16,7 @@ namespace Microsoft.PowerShell
/// gets the size of a file
/// </summary>
/// <param name="filePath"> path to file </param>
/// <returns>File size .</returns>
/// <remarks> </remarks>
/// <returns>File size.</returns>
internal static long GetFileSize(string filePath)
{
long size = 0;
@@ -35,8 +34,7 @@ namespace Microsoft.PowerShell
/// </summary>
/// <param name="hostUI"> ref to host ui interface </param>
/// <param name="prompt"> prompt text </param>
/// <returns>User input as secure string.</returns>
/// <remarks> </remarks>
/// <returns> user input as secure string.</returns>
internal static SecureString PromptForSecureString(PSHostUserInterface hostUI,
string prompt)
{
@@ -55,7 +53,6 @@ namespace Microsoft.PowerShell
/// <param name="errorId"> error identifier </param>
/// <param name="args"> replacement params for resource string formatting </param>
/// <returns></returns>
/// <remarks> </remarks>
internal static
ErrorRecord CreateFileNotFoundErrorRecord(string resourceStr,
string errorId,
@@ -84,7 +81,6 @@ namespace Microsoft.PowerShell
/// <param name="path"> path that was not found </param>
/// <param name="errorId"> error identifier </param>
/// <returns>ErrorRecord instance.</returns>
/// <remarks> </remarks>
internal static
ErrorRecord CreatePathNotFoundErrorRecord(string path,
string errorId)
@@ -108,7 +104,6 @@ namespace Microsoft.PowerShell
/// <param name="errorId"> error identifier </param>
/// <param name="args"> replacement params for resource string formatting </param>
/// <returns></returns>
/// <remarks> </remarks>
internal static
ErrorRecord CreateNotSupportedErrorRecord(string resourceStr,
string errorId,
@@ -134,7 +129,6 @@ namespace Microsoft.PowerShell
/// <param name="e"> exception to include in ErrorRecord </param>
/// <param name="errorId"> error identifier </param>
/// <returns></returns>
/// <remarks> </remarks>
internal static
ErrorRecord CreateInvalidArgumentErrorRecord(Exception e,
string errorId)
@@ -161,7 +155,6 @@ namespace Microsoft.PowerShell
/// filesystem path if all conditions are true,
/// null otherwise
/// </returns>
/// <remarks> </remarks>
internal static string GetFilePathOfExistingFile(PSCmdlet cmdlet,
string path)
{
@@ -177,4 +170,3 @@ namespace Microsoft.PowerShell
}
}
}
src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs
-2
View File
@@ -17,8 +17,6 @@ namespace System.Management.Automation.Runspaces
/// initialize default values of preference vars
/// </summary>
/// <returns>Does not return a value.</returns>
/// <remarks> </remarks>
private void InitializeDefaults()
{
SessionStateInternal ss = _engine.Context.EngineSessionState;
src/System.Management.Automation/engine/regex.cs
-1
View File
@@ -142,7 +142,6 @@ namespace System.Management.Automation
/// Instantiate internal regex member if not already done.
/// </summary>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
private void Init()
{
if (_isMatch == null)
src/System.Management.Automation/security/Authenticode.cs
-2
View File
@@ -89,7 +89,6 @@ namespace System.Management.Automation
/// <exception cref="System.IO.FileNotFoundException">
/// Thrown if the file specified by argument fileName is not found
/// </exception>
/// <remarks> </remarks>
[ArchitectureSensitive]
internal static Signature SignFile(SigningOption option,
string fileName,
@@ -269,7 +268,6 @@ namespace System.Management.Automation
/// <exception cref="System.IO.FileNotFoundException">
/// Thrown if the file specified by argument fileName is not found.
/// </exception>
/// <remarks> </remarks>
[ArchitectureSensitive]
internal static Signature GetSignature(string fileName, string fileContent)
{
src/System.Management.Automation/security/MshSignature.cs
-4
View File
@@ -195,7 +195,6 @@ namespace System.Management.Automation
/// <param name="signer"> cert of the signer </param>
/// <param name="timestamper"> cert of the time stamper </param>
/// <returns>Constructed object.</returns>
/// <remarks> </remarks>
internal Signature(string filePath,
DWORD error,
X509Certificate2 signer,
@@ -216,7 +215,6 @@ namespace System.Management.Automation
/// <param name="filePath"> this signature is found in this file </param>
/// <param name="signer"> cert of the signer </param>
/// <returns>Constructed object.</returns>
/// <remarks> </remarks>
internal Signature(string filePath,
X509Certificate2 signer)
{
@@ -235,7 +233,6 @@ namespace System.Management.Automation
/// <param name="error"> win32 error code </param>
/// <param name="signer"> cert of the signer </param>
/// <returns>Constructed object.</returns>
/// <remarks> </remarks>
internal Signature(string filePath,
DWORD error,
X509Certificate2 signer)
@@ -254,7 +251,6 @@ namespace System.Management.Automation
/// <param name="filePath"> this signature is found in this file </param>
/// <param name="error"> win32 error code </param>
/// <returns>Constructed object.</returns>
/// <remarks> </remarks>
internal Signature(string filePath, DWORD error)
{
Utils.CheckArgForNullOrEmpty(filePath, "filePath");
src/System.Management.Automation/security/SecureStringHelper.cs
+2 -4
View File
@@ -203,8 +203,7 @@ namespace Microsoft.PowerShell
/// </summary>
/// <param name="input"> input string to encrypt </param>
/// <param name="key"> encryption key </param>
/// <returns>A string (see summary) .</returns>
/// <remarks> </remarks>
/// <returns>A string (see summary).</returns>
internal static EncryptionResult Encrypt(SecureString input, SecureString key)
{
EncryptionResult output = null;
@@ -233,8 +232,7 @@ namespace Microsoft.PowerShell
/// </summary>
/// <param name="input"> input string to encrypt </param>
/// <param name="key"> encryption key </param>
/// <returns>A string (see summary) .</returns>
/// <remarks> </remarks>
/// <returns>A string (see summary).</returns>
internal static EncryptionResult Encrypt(SecureString input, byte[] key)
{
return Encrypt(input, key, null);
src/System.Management.Automation/security/SecuritySupport.cs
-7
View File
@@ -582,7 +582,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="filePath"> path to file </param>
/// <returns>Does not return a value.</returns>
/// <remarks> </remarks>
internal static void CheckIfFileExists(string filePath)
{
if (!File.Exists(filePath))
@@ -597,7 +596,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="c"> certificate object </param>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
internal static bool CertIsGoodForSigning(X509Certificate2 c)
{
if (!CertHasPrivatekey(c))
@@ -615,7 +613,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="c"> certificate object </param>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
internal static bool CertIsGoodForEncryption(X509Certificate2 c)
{
return (
@@ -663,7 +660,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="cert"> certificate object </param>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
internal static bool CertHasPrivatekey(X509Certificate2 cert)
{
return cert.HasPrivateKey;
@@ -674,7 +670,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="cert"> certificate object </param>
/// <returns>A collection of cert eku strings.</returns>
/// <remarks> </remarks>
[ArchitectureSensitive]
internal static Collection<string> GetCertEKU(X509Certificate2 cert)
{
@@ -733,7 +728,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="n"> signed int number </param>
/// <returns>DWORD.</returns>
/// <remarks> </remarks>
internal static DWORD GetDWORDFromInt(int n)
{
UInt32 result = BitConverter.ToUInt32(BitConverter.GetBytes(n), 0);
@@ -745,7 +739,6 @@ namespace System.Management.Automation.Internal
/// </summary>
/// <param name="n"> number </param>
/// <returns>Int.</returns>
/// <remarks> </remarks>
internal static int GetIntFromDWORD(DWORD n)
{
Int64 n64 = n - 0x100000000L;