Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2251,8 +2251,7 @@ protected override object GetChildItemsDynamicParameters(string path, bool recur
/// </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,
Expand Down Expand Up @@ -2516,8 +2515,7 @@ private X509NativeStore GetStore(string storePath,
/// <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,
Expand Down
12 changes: 2 additions & 10 deletions src/Microsoft.PowerShell.Security/security/Utils.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ internal static class SecurityUtils
/// 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;
Expand All @@ -35,8 +34,7 @@ internal static long GetFileSize(string filePath)
/// </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)
{
Expand All @@ -55,7 +53,6 @@ internal static SecureString PromptForSecureString(PSHostUserInterface hostUI,
/// <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,
Expand Down Expand Up @@ -84,7 +81,6 @@ ErrorRecord CreateFileNotFoundErrorRecord(string resourceStr,
/// <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)
Expand All @@ -108,7 +104,6 @@ ErrorRecord CreatePathNotFoundErrorRecord(string path,
/// <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,
Expand All @@ -134,7 +129,6 @@ ErrorRecord CreateNotSupportedErrorRecord(string resourceStr,
/// <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)
Expand All @@ -161,7 +155,6 @@ ErrorRecord CreateInvalidArgumentErrorRecord(Exception e,
/// filesystem path if all conditions are true,
/// null otherwise
/// </returns>
/// <remarks> </remarks>
internal static string GetFilePathOfExistingFile(PSCmdlet cmdlet,
string path)
{
Expand All @@ -177,4 +170,3 @@ internal static string GetFilePathOfExistingFile(PSCmdlet cmdlet,
}
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ class LocalRunspace : RunspaceBase
/// initialize default values of preference vars
/// </summary>
/// <returns>Does not return a value.</returns>
/// <remarks> </remarks>

private void InitializeDefaults()
{
SessionStateInternal ss = _engine.Context.EngineSessionState;
Expand Down
1 change: 0 additions & 1 deletion src/System.Management.Automation/engine/regex.cs
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,6 @@ public static WildcardPattern Get(string pattern, WildcardOptions options)
/// Instantiate internal regex member if not already done.
/// </summary>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
private void Init()
{
if (_isMatch == null)
Expand Down
2 changes: 0 additions & 2 deletions src/System.Management.Automation/security/Authenticode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ internal static class SignatureHelper
/// <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,
Expand Down Expand Up @@ -269,7 +268,6 @@ internal static Signature SignFile(SigningOption option,
/// <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)
{
Expand Down
4 changes: 0 additions & 4 deletions src/System.Management.Automation/security/MshSignature.cs
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,6 @@ public string Path
/// <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,
Expand All @@ -216,7 +215,6 @@ internal Signature(string filePath,
/// <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)
{
Expand All @@ -235,7 +233,6 @@ internal Signature(string filePath,
/// <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)
Expand All @@ -254,7 +251,6 @@ internal Signature(string filePath,
/// <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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,7 @@ internal static SecureString Unprotect(string input)
/// </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;
Expand Down Expand Up @@ -233,8 +232,7 @@ internal static EncryptionResult Encrypt(SecureString input, SecureString key)
/// </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);
Expand Down
7 changes: 0 additions & 7 deletions src/System.Management.Automation/security/SecuritySupport.cs
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,6 @@ internal static SaferPolicy GetSaferPolicy(string path, SafeHandle handle)
/// </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))
Expand All @@ -597,7 +596,6 @@ internal static void CheckIfFileExists(string filePath)
/// </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))
Expand All @@ -615,7 +613,6 @@ internal static bool CertIsGoodForSigning(X509Certificate2 c)
/// </summary>
/// <param name="c"> certificate object </param>
/// <returns>True on success, false otherwise.</returns>
/// <remarks> </remarks>
internal static bool CertIsGoodForEncryption(X509Certificate2 c)
{
return (
Expand Down Expand Up @@ -663,7 +660,6 @@ private static bool CertHasKeyUsage(X509Certificate2 c, X509KeyUsageFlags keyUsa
/// </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;
Expand All @@ -674,7 +670,6 @@ internal static bool CertHasPrivatekey(X509Certificate2 cert)
/// </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)
{
Expand Down Expand Up @@ -733,7 +728,6 @@ internal static Collection<string> GetCertEKU(X509Certificate2 cert)
/// </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);
Expand All @@ -745,7 +739,6 @@ internal static DWORD GetDWORDFromInt(int n)
/// </summary>
/// <param name="n"> number </param>
/// <returns>Int.</returns>
/// <remarks> </remarks>
internal static int GetIntFromDWORD(DWORD n)
{
Int64 n64 = n - 0x100000000L;
Expand Down