Skip to content
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.

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

Support grouping options by category in help generators #22

Open
rvesse opened this issue Jul 7, 2015 · 1 comment
Open

Support grouping options by category in help generators #22

rvesse opened this issue Jul 7, 2015 · 1 comment
Labels
annotations Java Annotations enhancement Proposed Enhancement/Feature help Help System
Milestone

Comments

@rvesse
Copy link
Owner

rvesse commented Jul 7, 2015

Requires adding a new category property to the @Option annotation (or a separate @OptionCategory) annotation to state category information

Help generators would then use this additional optional information to group options together in their outputs

@rvesse rvesse added enhancement Proposed Enhancement/Feature help Help System labels Jul 7, 2015
@rvesse rvesse added this to the Unscheduled milestone Jul 7, 2015
@rvesse rvesse modified the milestones: 2.0.0, Unscheduled Jul 23, 2015
@rvesse rvesse modified the milestones: Unscheduled, 2.0.0 Aug 13, 2015
@rvesse
Copy link
Owner Author

rvesse commented Feb 1, 2016

Suggested plan:

  • Add category field to @Option annotation
  • Add class level @OptionCategory annotation (and @OptionCategories) which has the following signature:
    @OptionCategory(title = "Title", description = "Describes the category", id = "id")
    Where id is the value that should be placed in the category field of @Option
  • Discover and store @OptionCategory meta-data in CommandMetadata (and maybe GroupMetadata/GlobalMetadata as well?)
  • Provide a Comparator<OptionMetadata> that does a category based sort of options
  • Update help generator implementations to understand how to print options with their associated category descriptors

@rvesse rvesse modified the milestones: 2.3.0, Unscheduled Sep 20, 2016
@rvesse rvesse added the annotations Java Annotations label Sep 27, 2016
@rvesse rvesse modified the milestones: Unscheduled, 2.3.0 Dec 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
annotations Java Annotations enhancement Proposed Enhancement/Feature help Help System
Projects
None yet
Development

No branches or pull requests

1 participant