Skip to content

Update docs for ArgumentCompleterAttribute class #7227

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 2 commits into from
Jul 6, 2018
Merged

Update docs for ArgumentCompleterAttribute class #7227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abe1caf
update docs for ArgumentCompleterAttribute class
Meir017 Jul 3, 2018
3607e6a
more code comments
Meir017 Jul 5, 2018
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
6 changes: 6 additions & 0 deletions src/System.Management.Automation/engine/Attributes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1259,7 +1259,9 @@ public sealed class ValidatePatternAttribute : ValidateEnumeratedArgumentsAttrib
/// The text representation of the object being validated and the validating regex is passed as
/// the first and second formatting parameters to the ErrorMessage formatting pattern.
/// <example>
/// <code>
/// [ValidatePattern("\s+", ErrorMessage="The text '{0}' did not pass validation of regex '{1}'")]
/// </code>
/// </example>
/// </summary>
public string ErrorMessage { get; set; }
Expand Down Expand Up @@ -1322,7 +1324,9 @@ public sealed class ValidateScriptAttribute : ValidateEnumeratedArgumentsAttribu
/// formatting argument.
///
/// <example>
/// <code>
/// [ValidateScript("$_ % 2", ErrorMessage = "The item '{0}' did not pass validation of script '{1}'")]
/// </code>
/// </example>
/// </summary>
public string ErrorMessage { get; set; }
Expand Down Expand Up @@ -1569,7 +1573,9 @@ public sealed class ValidateSetAttribute : ValidateEnumeratedArgumentsAttribute
/// is passed as the first and second formatting argument to the ErrorMessage formatting pattern.
///
/// <example>
/// <code>
/// [ValidateSet("A","B","C", ErrorMessage="The item '{0}' is not part of the set '{1}'.")
/// </code>
/// </example>
/// </summary>
public string ErrorMessage { get; set; }
Expand Down
2 changes: 2 additions & 0 deletions src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ namespace System.Management.Automation
/// <summary>
/// This attribute is used to specify an argument completer for a parameter to a cmdlet or function.
/// <example>
/// <code>
/// [Parameter()]
/// [ArgumentCompleter(typeof(NounArgumentCompleter))]
/// public string Noun { get; set; }
/// </code>
/// </example>
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
Expand Down