Skip to content

Use xml documentation child blocks correctly #14249

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 3 commits into from
Nov 26, 2020
Merged

Use xml documentation child blocks correctly #14249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
451b326
Escape xml entities
xtqqczze Nov 23, 2020
cc72ea1
Close tag
xtqqczze Nov 23, 2020
7c87bbb
Fix DOC101: Use child blocks consistently
xtqqczze Nov 23, 2020
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
4 changes: 2 additions & 2 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,20 +91,20 @@ internal InvocationContext(string computerName, CimInstance targetCimInstance)
/// <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
Expand Down
4 changes: 3 additions & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ public string Name
/// </para>
/// <para>
/// The unit is Second.
/// <para>
/// </para>
/// </summary>
[Alias(AliasOT)]
[Parameter(ValueFromPipelineByPropertyName = true)]
Expand Down Expand Up @@ -191,9 +191,11 @@ public UInt32 Port
/// 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
Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/SetCimInstanceCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,10 @@ public IDictionary Property
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.
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public int Depth
/// <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;
Expand Down