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.

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

Jump to bottom

Add MooseEnum option documentation #23004

Closed
dschwen opened this issue Dec 21, 2022 · 1 comment · Fixed by #23012
Closed

Add MooseEnum option documentation #23004

dschwen opened this issue Dec 21, 2022 · 1 comment · Fixed by #23012
Assignees
@dschwen
Labels
C: Documentation T: task An enhancement to the software.

Comments

@dschwen
Copy link
Member

dschwen commented Dec 21, 2022

Reason

To enrich auto completion and documentation page generation, MooseEnum items should have individual documentation strings.

Design

Add a map to MooseEnumBase that holds a doc string for each item. Add myenum.addDocumentation("ITEM", "Doc string."); and myenum.addDocumentation({{"ITEM1", "Doc string1."}, {"ITEM1", "Doc string1."}}); methods.

Emit the doc strings in the JSON dump.

Impact

Better self documentation.
@dschwen dschwen added the T: task An enhancement to the software. label Dec 21, 2022
@dschwen dschwen self-assigned this Dec 21, 2022
@friedmud
Copy link
Contributor

Ooooh - I like this idea!

dschwen added a commit to dschwen/moose that referenced this issue Dec 22, 2022
@dschwen
Add and emit moose enum docs (idaholab#23004)
3356b29
@dschwen dschwen mentioned this issue Dec 22, 2022
Merged
dschwen added a commit to dschwen/moose that referenced this issue Dec 23, 2022
@dschwen
Add YAML output (idaholab#23004)
6806f3f
@dschwen dschwen mentioned this issue Dec 25, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dschwen dschwen

Labels
C: Documentation T: task An enhancement to the software.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add and emit moose enum docs dschwen/moose
3 participants
@dschwen @friedmud @GiudGiud