Skip to content

Usage help parameter list details should indicate arity for positional parameters #198

@remkop

Description

@remkop

E.g.

class App {
    @Parameters(arity = "2", split = "\\|", type = {Integer.class, String.class},
            paramLabel = "FIXTAG=VALUE",
            description = "Exactly two lists of vertical bar '|'-separated FIXTAG=VALUE pairs.")
    Map<Integer,String> message;

    @Option(names = {"-P", "-map"}, split = ",", type = {TimeUnit.class, String.class},
            paramLabel = "TIMEUNIT=VALUE",
            description = "Any number of TIMEUNIT=VALUE pairs. These may be specified separately (-PTIMEUNIT=VALUE) or as a comma-separated list.")
    Map<TimeUnit, String> map;
}

Should show

Usage: <main class> [-P=TIMEUNIT=VALUE[,TIMEUNIT=VALUE]...]... FIXTAG=VALUE
                    [\|FIXTAG=VALUE]... FIXTAG=VALUE[\|FIXTAG=VALUE]...
      FIXTAG=VALUE[\|FIXTAG=VALUE]... FIXTAG=VALUE[\|FIXTAG=VALUE]...
                              Exactly two lists of vertical bar '|'-separated
                                FIXTAG=VALUE pairs.
  -P, -map=TIMEUNIT=VALUE[,TIMEUNIT=VALUE]...
                              Any number of TIMEUNIT=VALUE pairs. These may be
                                specified separately (-PTIMEUNIT=VALUE) or as a
                                comma-separated list.

Currently shows

Usage: <main class> [-P=TIMEUNIT=VALUE[,TIMEUNIT=VALUE]...]... FIXTAG=VALUE
                    [\|FIXTAG=VALUE]... FIXTAG=VALUE[\|FIXTAG=VALUE]...
      FIXTAG=VALUE            Exactly two lists of vertical bar '|'-separated
                                FIXTAG=VALUE pairs.
  -P, -map=TIMEUNIT=VALUE[,TIMEUNIT=VALUE]...
                              Any number of TIMEUNIT=VALUE pairs. These may be
                                specified separately (-PTIMEUNIT=VALUE) or as a
                                comma-separated list.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions