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-
The Javadoc
@valuetag 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-