Skip to content

Improve inline documentation for VerbInfo #13265

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
anmenaga merged 1 commit into from
Aug 10, 2020
Merged

Improve inline documentation for VerbInfo #13265

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
10 changes: 5 additions & 5 deletions src/System.Management.Automation/utils/Verbs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1116,36 +1116,36 @@ public static string GetVerbAliasPrefix(string verb)
}

/// <summary>
/// Class for Verbs and Groups.
/// Provides information about a verb used to name commands defined in PowerShell.
/// </summary>
public class VerbInfo
{
/// <summary>
/// Verb Name.
/// The verb name, used to begin command names.
/// </summary>
public string Verb
{
get; set;
}

/// <summary>
/// Alias Prefix.
/// The alias prefix, recommended for aliases to commands that begin with this verb.
/// </summary>
public string AliasPrefix
{
get; set;
}

/// <summary>
/// Group Name.
/// The name of the functional category of commands that begin with this verb.
/// </summary>
public string Group
{
get; set;
}

/// <summary>
/// Description.
/// Explains what the verb is meant to do with its object.
/// </summary>
public string Description
{
Expand Down