maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add complete xml docs for ConvertToJsonContext constructors (#8737)

Browse source
This commit is contained in:
Dongbo Wang 2019-01-25 12:02:41 -08:00 committed by Andrew
parent 89b2dcdeff
commit 12547c01e8
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs
View file

@ -60,16 +60,25 @@ namespace Microsoft.PowerShell.Commands
public readonly PSCmdlet Cmdlet;
/// <summary>
/// Constructor of ConvertToJsonContext.
/// Initializes a new instance of the <see cref="ConvertToJsonContext"/> struct.
/// </summary>
/// <param name="maxDepth">The maximum depth to visit the object.</param>
/// <param name="enumsAsStrings">Indicates whether to use enum names for the JSON conversion.</param>
/// <param name="compressOutput">Indicates whether to get the compressed output.</param>
public ConvertToJsonContext(int maxDepth, bool enumsAsStrings, bool compressOutput)
: this(maxDepth, enumsAsStrings, compressOutput, CancellationToken.None, StringEscapeHandling.Default, targetCmdlet: null)
{
}
/// <summary>
/// Constructor of ConvertToJsonContext.
/// Initializes a new instance of the <see cref="ConvertToJsonContext"/> struct.
/// </summary>
/// <param name="maxDepth">The maximum depth to visit the object.</param>
/// <param name="enumsAsStrings">Indicates whether to use enum names for the JSON conversion.</param>
/// <param name="compressOutput">Indicates whether to get the compressed output.</param>
/// <param name="cancellationToken">Specifies the cancellation token for cancelling the operation.</param>
/// <param name="stringEscapeHandling">Specifies how strings are escaped when writing JSON text.</param>
/// <param name="targetCmdlet">Specifies the cmdlet that is calling this method.</param>
public ConvertToJsonContext(
int maxDepth,
bool enumsAsStrings,