Skip to content

Use see keyword in documentation #14220

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.

Sign up for GitHub

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
iSazonov merged 1 commit into from
Nov 24, 2020
Merged

Use see keyword in documentation #14220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1637,7 +1637,7 @@ internal IObjectPreProcess ObjectPreProcess
private IObjectPreProcess objectPreprocess;

/// <summary>
/// <see cref="isDefaultSession"/> is <c>true</c> if this <see cref="CimSessionProxy"/> was
/// <see cref="isDefaultSession"/> is <see langword="true"/> if this <see cref="CimSessionProxy"/> was
/// created to handle the "default" session, in cases where cmdlets are invoked without
/// ComputerName and/or CimSession parameters.
/// </summary>
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ private StartableJob DoCreateQueryJob(TSession sessionForJob, QueryBuilder query
/// <param name="session">Remote session to invoke the method in.</param>
/// <param name="objectInstance">The object on which to invoke the method.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <remarks>
/// <para>
/// This method shouldn't do any processing or interact with the remote session.
Expand Down Expand Up @@ -397,7 +397,7 @@ public override void ProcessRecord(QueryBuilder query)
/// </summary>
/// <param name="query">Query parameters.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the object instance being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the object instance being operated on.</param>
public override void ProcessRecord(QueryBuilder query, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
_parentJob.DisableFlowControlForPendingJobsQueue();
Expand Down Expand Up @@ -576,7 +576,7 @@ private TSession GetImpliedSession()
/// </summary>
/// <param name="objectInstance">The object on which to invoke the method.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
public override void ProcessRecord(TObjectInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
if (objectInstance == null) throw new ArgumentNullException(nameof(objectInstance));
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,8 @@ private static string GetMatchCondition(string propertyName, IEnumerable propert
/// <param name="propertyName">Property name to query on.</param>
/// <param name="allowedPropertyValues">Property values to accept in the query.</param>
/// <param name="wildcardsEnabled">
/// <c>true</c> if <paramref name="allowedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <c>false otherwise</c>
/// <see langword="true"/> if <paramref name="allowedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <see langword="false"/> otherwise.
/// </param>
/// <param name="behaviorOnNoMatch">
/// Describes how to handle filters that didn't match any objects
Expand All @@ -219,8 +219,8 @@ public override void FilterByProperty(string propertyName, IEnumerable allowedPr
/// <param name="propertyName">Property name to query on.</param>
/// <param name="excludedPropertyValues">Property values to reject in the query.</param>
/// <param name="wildcardsEnabled">
/// <c>true</c> if <paramref name="excludedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <c>false otherwise</c>
/// <see langword="true"/> if <paramref name="excludedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <see langword="false"/> otherwise.
/// </param>
/// <param name="behaviorOnNoMatch">
/// Describes how to handle filters that didn't match any objects
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ internal override StartableJob CreateQueryJob(CimSession session, QueryBuilder b
/// <param name="session">Remote session to invoke the method in.</param>
/// <param name="objectInstance">The object on which to invoke the method.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <returns></returns>
internal override StartableJob CreateInstanceMethodInvocationJob(CimSession session, CimInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1107,7 +1107,7 @@ private Dictionary<K, V> RehydrateDictionary<K, V>(string commandName, PSObject
/// (i.e. it can't be used for code injection attacks).
/// </summary>
/// <param name="name">Name to validate.</param>
/// <returns><c>true</c> if the name is safe; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if the name is safe; <see langword="false"/> otherwise.</returns>
private static bool IsSafeNameOrIdentifier(string name)
{
// '.' is needed for stuff like net.exe
Expand All @@ -1125,7 +1125,7 @@ private static bool IsSafeNameOrIdentifier(string name)
/// (i.e. it can't be used for code injection attacks).
/// </summary>
/// <param name="parameterName">Parameter name to validate.</param>
/// <returns><c>true</c> if the name is safe; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if the name is safe; <see langword="false"/> otherwise.</returns>
private static bool IsSafeParameterName(string parameterName)
{
return IsSafeNameOrIdentifier(parameterName) && !parameterName.Contains(":");
Expand All @@ -1136,7 +1136,7 @@ private static bool IsSafeParameterName(string parameterName)
/// (i.e. it doesn't introduce any side effects on the client).
/// </summary>
/// <param name="type">Type to validate.</param>
/// <returns><c>true</c> if the type is safe; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if the type is safe; <see langword="false"/> otherwise.</returns>
private static bool IsSafeTypeConstraint(Type type)
{
if (type == null)
Expand Down Expand Up @@ -1179,7 +1179,7 @@ private static bool IsSafeTypeConstraint(Type type)
/// Writes error messages if necessary. Modifies command metadata to make it safe if necessary.
/// </summary>
/// <param name="commandMetadata">Command metadata to verify.</param>
/// <returns><c>true</c> if the command metadata is safe; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if the command metadata is safe; <see langword="false"/> otherwise.</returns>
private bool IsSafeCommandMetadata(CommandMetadata commandMetadata)
{
if (!IsCommandNameMatchingParameters(commandMetadata.Name))
Expand Down
4 changes: 2 additions & 2 deletions ...l.Commands.Utility/commands/utility/WebCmdlet/Common/BasicHtmlWebResponseObject.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public BasicHtmlWebResponseObject(HttpResponseMessage response, Stream contentSt
/// <value>
/// Content of the response body, decoded using <see cref="Encoding"/>,
/// if the <c>Content-Type</c> response header is a recognized text
/// type. Otherwise <c>null</c>.
/// type. Otherwise <see langword="null"/>.
/// </value>
public new string Content { get; private set; }

Expand All @@ -70,7 +70,7 @@ public BasicHtmlWebResponseObject(HttpResponseMessage response, Stream contentSt
/// </summary>
/// <value>
/// Encoding of the response body from the <c>Content-Type</c> header,
/// or <c>null</c> if the encoding could not be determined.
/// or <see langword="null"/> if the encoding could not be determined.
/// </value>
public Encoding Encoding { get; private set; }

Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public PSPropertyExpression(string s)
/// Create a property expression with a wildcard pattern.
/// </summary>
/// <param name="s">Property name pattern to match.</param>
/// <param name="isResolved"><c>true</c> if no further attempts should be made to resolve wildcards.</param>
/// <param name="isResolved"><see langword="true"/> if no further attempts should be made to resolve wildcards.</param>
/// <exception cref="ArgumentNullException"></exception>
public PSPropertyExpression(string s, bool isResolved)
{
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/cimSupport/cmdletization/MethodInvocationInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public sealed class MethodInvocationInfo
/// </summary>
/// <param name="name">Name of the method to invoke.</param>
/// <param name="parameters">Method parameters.</param>
/// <param name="returnValue">Return value of the method (ok to pass <c>null</c> if the method doesn't return anything).</param>
/// <param name="returnValue">Return value of the method (ok to pass <see langword="null"/> if the method doesn't return anything).</param>
public MethodInvocationInfo(string name, IEnumerable<MethodParameter> parameters, MethodParameter returnValue)
{
if (name == null) throw new ArgumentNullException(nameof(name));
Expand Down Expand Up @@ -48,7 +48,7 @@ public MethodInvocationInfo(string name, IEnumerable<MethodParameter> parameters
public KeyedCollection<string, MethodParameter> Parameters { get; }

/// <summary>
/// Return value of the method. Can be <c>null</c> if the method doesn't return anything.
/// Return value of the method. Can be <see langword="null"/> if the method doesn't return anything.
/// </summary>
public MethodParameter ReturnValue { get; }

Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/cimSupport/cmdletization/MethodParameter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public sealed class MethodParameter
public Type ParameterType { get; set; }

/// <summary>
/// Contents of the ETS type attribute in the CDXML file (or <c>null</c> if that attribute was not specified).
/// Contents of the ETS type attribute in the CDXML file (or <see langword="null"/> if that attribute was not specified).
/// The expectation is that the CmdletAdapter will stamp this value onto PSTypeNames of emitted objects.
/// </summary>
public string ParameterTypeName { get; set; }
Expand Down
6 changes: 3 additions & 3 deletions src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public virtual void StopProcessing()
/// </summary>
/// <param name="objectInstance">The object on which to invoke the method.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
public virtual void ProcessRecord(TObjectInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
throw new NotImplementedException();
Expand All @@ -138,7 +138,7 @@ public virtual void ProcessRecord(TObjectInstance objectInstance, MethodInvocati
/// </summary>
/// <param name="query">Query parameters.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><c>true</c> if successful method invocations should emit downstream the object instance being operated on.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the object instance being operated on.</param>
public virtual void ProcessRecord(QueryBuilder query, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
throw new NotImplementedException();
Expand Down Expand Up @@ -182,7 +182,7 @@ public string ClassName

/// <summary>
/// Name of the class (from the object model handled by this ObjectModelWrapper) that is wrapped by the currently executing cmdlet.
/// This value can be <c>null</c> (i.e. when ClassVersion attribute is omitted in the ps1xml)
/// This value can be <see langword="null"/> (i.e. when ClassVersion attribute is omitted in the ps1xml)
/// </summary>
public string ClassVersion
{
Expand Down
8 changes: 4 additions & 4 deletions src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public abstract class QueryBuilder
/// <param name="propertyName">Property name to query on.</param>
/// <param name="allowedPropertyValues">Property values to accept in the query.</param>
/// <param name="wildcardsEnabled">
/// <c>true</c> if <paramref name="allowedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <c>false otherwise</c>
/// <see langword="true"/> if <paramref name="allowedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <see langword="false"/> otherwise.
/// </param>
/// <param name="behaviorOnNoMatch">
/// Describes how to handle filters that didn't match any objects
Expand All @@ -69,8 +69,8 @@ public virtual void FilterByProperty(string propertyName, IEnumerable allowedPro
/// <param name="propertyName">Property name to query on.</param>
/// <param name="excludedPropertyValues">Property values to reject in the query.</param>
/// <param name="wildcardsEnabled">
/// <c>true</c> if <paramref name="excludedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <c>false otherwise</c>
/// <see langword="true"/> if <paramref name="excludedPropertyValues"/> should be treated as a <see cref="System.String"/> containing a wildcard pattern;
/// <see langword="false"/> otherwise.
/// </param>
/// <param name="behaviorOnNoMatch">
/// Describes how to handle filters that didn't match any objects
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/CommandProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@ private void InitCommon()
/// </summary>
/// <param name="helpTarget">Help target to request.</param>
/// <param name="helpCategory">Help category to request.</param>
/// <returns><c>true</c> if user requested help; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if user requested help; <see langword="false"/> otherwise.</returns>
internal override bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory)
{
if (this.arguments != null)
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/CommandProcessorBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ internal ExecutionContext Context
/// </summary>
/// <param name="helpTarget">Help target to request.</param>
/// <param name="helpCategory">Help category to request.</param>
/// <returns><c>true</c> if user requested help; <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if user requested help; <see langword="false"/> otherwise.</returns>
internal virtual bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory)
{
// by default we don't handle "-?" parameter at all
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/engine/FunctionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ internal void Update(ScriptBlock newFunction, bool force, ScopedItemOptions opti
}

/// <summary>
/// Returns <c>true</c> if this function uses cmdlet binding mode for its parameters; otherwise returns <c>false</c>.
/// Returns <see langword="true"/> if this function uses cmdlet binding mode for its parameters; otherwise returns <see langword="false"/>.
/// </summary>
public bool CmdletBinding
{
Expand All @@ -277,7 +277,7 @@ public bool CmdletBinding

/// <summary>
/// Gets the name of the default parameter set.
/// Returns <c>null</c> if this function doesn't use cmdlet parameter binding or if the default parameter set wasn't specified.
/// Returns <see langword="null"/> if this function doesn't use cmdlet parameter binding or if the default parameter set wasn't specified.
/// </summary>
public string DefaultParameterSet
{
Expand Down
Loading