Use xml documentation child blocks correctly (#14249)

This commit is contained in:
xtqqczze
2020-11-26 10:36:23 +05:00
committed by GitHub
parent 17b3375eea
commit b5fc2f34e4
4 changed files with 8 additions and 4 deletions
@@ -91,20 +91,20 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
/// <para>
/// ComputerName of the session
/// </para>
/// </summary>
/// <remarks>
/// return value could be null
/// </remarks>
/// </summary>
internal virtual string ComputerName { get; }
/// <summary>
/// <para>
/// CimInstance on which the current operation against.
/// </para>
/// </summary>
/// <remarks>
/// return value could be null
/// </remarks>
/// </summary>
internal virtual CimInstance TargetCimInstance { get; }
}
#endregion
@@ -97,7 +97,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
/// </para>
/// <para>
/// The unit is Second.
/// <para>
/// </para>
/// </summary>
[Alias(AliasOT)]
[Parameter(ValueFromPipelineByPropertyName = true)]
@@ -153,9 +153,11 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
/// If the argument is not given, a default SessionOption will be created for
/// the session in .NET API layer.
/// </para>
/// <para>
/// If a <see cref="DCOMSessionOption"/> object is passed, then
/// connection is made using DCOM. If a <see cref="WsManSessionOption"/>
/// object is passed, then connection is made using WsMan.
/// </para>
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
public Microsoft.Management.Infrastructure.Options.CimSessionOptions SessionOption { get; set; }
@@ -256,8 +256,10 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
private IDictionary property;
/// <summary>
/// <para>
/// The following is the definition of the input parameter "PassThru",
/// indicate whether Set-CimInstance should output modified result instance or not.
/// </para>
/// <para>
/// True indicates output the result instance, otherwise output nothing as by default
/// behavior.
@@ -72,7 +72,7 @@ namespace Microsoft.PowerShell.Commands
/// <summary>
/// Specifies how strings are escaped when writing JSON text.
/// If the EscapeHandling property is set to EscapeHtml, the result JSON string will
/// be returned with HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped.
/// be returned with HTML (&lt;, &gt;, &amp;, ', ") and control characters (e.g. newline) are escaped.
/// </summary>
[Parameter]
public StringEscapeHandling EscapeHandling { get; set; } = StringEscapeHandling.Default;