From a469e8f340aa211a2adcee666d61ca32e52ddbea Mon Sep 17 00:00:00 2001 From: Florian Weikert Date: Mon, 20 Jun 2016 14:55:41 +0000 Subject: Don't generate links for non-documented modules since this results in dead links. -- MOS_MIGRATED_REVID=125336775 --- .../com/google/devtools/build/docgen/skylark/SkylarkDoc.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'src/main/java/com') 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 "None"; } 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 "" + module + ""; - } else { - return EvalUtils.getDataTypeNameFromClass(type); + SkylarkModule module = type.getAnnotation(SkylarkModule.class); + if (module.documented()) { + return String.format("%1$s", + module.name()); + } } + return EvalUtils.getDataTypeNameFromClass(type); } // Elide self parameter from parameters in class methods. -- cgit v1.2.3