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

Feature request: render Javadoc value tag correctly. #189

Open
samuelklee opened this issue Oct 21, 2022 · 2 comments
Open

Feature request: render Javadoc value tag correctly. #189

samuelklee opened this issue Oct 21, 2022 · 2 comments
Assignees

Comments

@samuelklee
Copy link

The Javadoc @value tag can be useful for referencing argument names in tool docs by their Java variable names. This obviates the need to manually keep the docs in sync (or e.g. rely on IntelliJ rename or find-and-replace functionality) when changing the argument names. Unfortunately, it does not appear that this tag is respected when rendering the docs. See https://broadinstitute.slack.com/archives/C1HH1V5EC/p1666140481830649 for more context and an example in https://gatk.broadinstitute.org/hc/en-us/articles/9570326304155-ScoreVariantAnnotations-BETA-

@cmnbroad cmnbroad self-assigned this Oct 24, 2022
@cmnbroad
Copy link
Collaborator

Will fix this in the Barclay Java 17 branch, since the new Java language model classes make it easy to detect and and expand these.

@cmnbroad
Copy link
Collaborator

cmnbroad commented Jan 9, 2023

Update: see broadinstitute/gatk#8146

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants