aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
diff options
context:
space:
mode:
authorGravatar vladmos <vladmos@google.com>2017-12-13 09:04:13 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2017-12-13 09:05:31 -0800
commita9cd97c8075e1d7f3a2662795bde7afffa940dd3 (patch)
tree8f3238d273373b481a3790dab93235145510ca2b /src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
parente8a83afe35b11385976349fdf421d4a353e6d938 (diff)
Fix the documentation to allow making links to BE documetation articles
PiperOrigin-RevId: 178910168
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java24
1 files changed, 19 insertions, 5 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
index 8cd0e17761..f6525f6849 100644
--- a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
+++ b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
@@ -30,7 +30,9 @@ import java.util.List;
import java.util.Locale;
import java.util.Map;
-/** A class to assemble documentation for Skylark. */
+/**
+ * A class to assemble documentation for Skylark.
+ */
public final class SkylarkDocumentationProcessor {
private static final ImmutableList<SkylarkModuleCategory> GLOBAL_CATEGORIES =
@@ -39,10 +41,14 @@ public final class SkylarkDocumentationProcessor {
private SkylarkDocumentationProcessor() {}
- /** Generates the Skylark documentation to the given output directory. */
- public static void generateDocumentation(String outputDir, String... clazz)
+ /**
+ * Generates the Skylark documentation to the given output directory.
+ */
+ public static void generateDocumentation(String outputDir, String... args)
throws IOException, ClassPathException {
- Map<String, SkylarkModuleDoc> modules = SkylarkDocumentationCollector.collectModules(clazz);
+ parseOptions(args);
+
+ Map<String, SkylarkModuleDoc> modules = SkylarkDocumentationCollector.collectModules();
// Generate the top level module first in the doc
SkylarkModuleDoc topLevelModule = modules.remove(
@@ -188,7 +194,7 @@ public final class SkylarkDocumentationProcessor {
} else {
return getFunctionDoc(module.getAnnotation().name(), params[1], module);
}
- } else if (toplevelModuleDoc.getBuiltinMethods().containsKey(params[0])){
+ } else if (toplevelModuleDoc.getBuiltinMethods().containsKey(params[0])) {
// Top level object / function
return getFunctionDoc(null, params[0], toplevelModuleDoc);
}
@@ -233,4 +239,12 @@ public final class SkylarkDocumentationProcessor {
sb.append(method.getSignature())
.append("\t").append(method.getDocumentation()).append("\n");
}
+
+ private static void parseOptions(String... args) {
+ for (String arg : args) {
+ if (arg.startsWith("--be_root=")) {
+ DocgenConsts.BEDocsRoot = arg.split("--be_root=", 2)[1];
+ }
+ }
+ }
}