diff options
author | 2016-06-20 14:55:41 +0000 | |
---|---|---|
committer | 2016-06-21 09:57:54 +0000 | |
commit | a469e8f340aa211a2adcee666d61ca32e52ddbea (patch) | |
tree | 5ebe64d1f384558ba4ddd76e5a245d747e030494 /src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java | |
parent | fd71b4fcb6796841ca434602aaf98ae99daf1783 (diff) |
Don't generate links for non-documented modules since this results in dead links.
--
MOS_MIGRATED_REVID=125336775
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java')
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java index 3f4f5ae143..01f84e7dfe 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDoc.java @@ -63,13 +63,13 @@ abstract class SkylarkDoc { } else if (type.equals(Void.TYPE) || type.equals(NoneType.class)) { return "<a class=\"anchor\" href=\"" + TOP_LEVEL_ID + ".html#None\">None</a>"; } else if (type.isAnnotationPresent(SkylarkModule.class)) { - // TODO(bazel-team): this can produce dead links for types don't show up in the doc. - // The correct fix is to generate those types (e.g. SkylarkFileType) too. - String module = type.getAnnotation(SkylarkModule.class).name(); - return "<a class=\"anchor\" href=\"" + module + ".html\">" + module + "</a>"; - } else { - return EvalUtils.getDataTypeNameFromClass(type); + SkylarkModule module = type.getAnnotation(SkylarkModule.class); + if (module.documented()) { + return String.format("<a class=\"anchor\" href=\"%1$s.html\">%1$s</a>", + module.name()); + } } + return EvalUtils.getDataTypeNameFromClass(type); } // Elide self parameter from parameters in class methods. |