broadinstitute / barclay

Command line argument parser and online documentation generation utilities for java command line programs.
BSD 3-Clause "New" or "Revised" License
9 stars 6 forks source link

Feature request: render Javadoc value tag correctly. #189

Open samuelklee opened 1 year ago

samuelklee commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Update: see https://github.com/broadinstitute/gatk/issues/8146