Description (Command Line Parsing API)

Skip navigation links

org.netbeans.modules.sendopts/2 2.34.1

All Classes

SEARCH:

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target(FIELD)
@Retention(RUNTIME)
public @interface Description
```
Adds human readable description to @Arg annotation. Can be attached to public non-static fields that are also annotated by @Arg.

Since:

2.20

- Required Element Summary
  
  Required Elements
  Modifier and Type Required Element Description
  
  java.lang.String shortDescription
  Explanation of the purpose of the option.
- Optional Element Summary
  
  Optional Elements
  Modifier and Type Optional Element Description
  
  java.lang.String displayName
  Specific display name for the option.

- Element Detail
  - shortDescription
```
java.lang.String shortDescription
```
    Explanation of the purpose of the option. Specify by using NbBundle.Messages.
    
    Returns:
    
    explanation of the purpose of the option
- - displayName
```
java.lang.String displayName
```
    Specific display name for the option. If not specified, it is inferred from the name of the option and the type of its parameters. Specify with using of NbBundle.Messages.
    
    Returns:
    
    specific display name
    
    Default:
    
    ""

Skip navigation links

org.netbeans.modules.sendopts/2 2.34.1

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.