diff options
author | 2016-06-22 15:34:25 +0000 | |
---|---|---|
committer | 2016-06-23 11:03:11 +0000 | |
commit | dba6223afff671df63901814c7424dc7a7243004 (patch) | |
tree | aa15c2cff6a8cd300ba0b3e260514156d60a662c /src/main/java/com | |
parent | 590209f9c28e30c3643296a0284a046a9b7e8d36 (diff) |
Add anchors to the flags in the HTML help output.
--
MOS_MIGRATED_REVID=125568305
Diffstat (limited to 'src/main/java/com')
-rw-r--r-- | src/main/java/com/google/devtools/common/options/OptionsUsage.java | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/common/options/OptionsUsage.java b/src/main/java/com/google/devtools/common/options/OptionsUsage.java index b64506dd1e..3c5dbb928a 100644 --- a/src/main/java/com/google/devtools/common/options/OptionsUsage.java +++ b/src/main/java/com/google/devtools/common/options/OptionsUsage.java @@ -131,10 +131,12 @@ class OptionsUsage { * Append the usage message for a single option-field message to 'usage'. */ static void getUsageHtml(Field optionField, StringBuilder usage, Escaper escaper) { + String plainFlagName = optionField.getAnnotation(Option.class).name(); String flagName = getFlagName(optionField); String typeDescription = getTypeDescription(optionField); Option annotation = optionField.getAnnotation(Option.class); - usage.append("<dt><code>--").append(flagName).append("</code>"); + usage.append("<dt><code><a href=\"#flag--").append(plainFlagName).append("\"></a>--"); + usage.append(flagName).append("</code>"); if (annotation.abbrev() != '\0') { usage.append(" [<code>-").append(annotation.abbrev()).append("</code>]"); } @@ -164,7 +166,8 @@ class OptionsUsage { usage.append("<br/>\n"); StringBuilder expandsMsg = new StringBuilder("Expands to:"); for (String exp : annotation.expansion()) { - expandsMsg.append(" ").append(exp); + // TODO(ulfjack): Can we link to the expanded flags here? + expandsMsg.append(" <code>").append(exp).append("</code>"); } usage.append(paragraphFill(escaper.escape(expandsMsg.toString()), 0, 80)); // (indent, width) usage.append('\n'); |