diff options
author | 2017-02-21 21:30:45 +0000 | |
---|---|---|
committer | 2017-02-22 08:28:25 +0000 | |
commit | 85cc0431bf7ab5e87664f0932c6aa46de5fb0a8d (patch) | |
tree | 07bd216bf22eeff236da4cea566051881788ad3b /src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java | |
parent | 7463237970f82ace1864f461034d8570fba647f2 (diff) |
Skylark documentation pipeline automatically generates documentation for all Skylark modules.
With this change, we no longer have to manually register modules whose generation should be generated. Manual registration turned out to be prone to errors since engineers didn't know about it or simply forgot to register their modules. As a result, we had ~20 modules that featured nice documentation texts, but that were not being picked up by the documentation pipeline.
--
PiperOrigin-RevId: 148136776
MOS_MIGRATED_REVID=148136776
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.java | 12 |
1 files changed, 5 insertions, 7 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 107a9bf053..a275b545f9 100644 --- a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java +++ b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java @@ -17,7 +17,7 @@ import com.google.devtools.build.docgen.skylark.SkylarkBuiltinMethodDoc; import com.google.devtools.build.docgen.skylark.SkylarkJavaMethodDoc; import com.google.devtools.build.docgen.skylark.SkylarkModuleDoc; import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; - +import com.google.devtools.build.lib.util.Classpath.ClassPathException; import java.io.File; import java.io.IOException; import java.util.ArrayList; @@ -31,11 +31,9 @@ import java.util.Map; public final class SkylarkDocumentationProcessor { private SkylarkDocumentationProcessor() {} - /** - * Generates the Skylark documentation to the given output directory. - */ - public static void generateDocumentation(String outputDir, String... clazz) throws IOException, - BuildEncyclopediaDocException { + /** Generates the Skylark documentation to the given output directory. */ + public static void generateDocumentation(String outputDir, String... clazz) + throws IOException, ClassPathException { Map<String, SkylarkModuleDoc> modules = SkylarkDocumentationCollector.collectModules(clazz); // Generate the top level module first in the doc @@ -95,7 +93,7 @@ public final class SkylarkDocumentationProcessor { * method in the module.<br> * Returns null if no Skylark object is found. */ - public static String getCommandLineAPIDoc(String[] params) { + public static String getCommandLineAPIDoc(String[] params) throws ClassPathException { Map<String, SkylarkModuleDoc> modules = SkylarkDocumentationCollector.collectModules(); SkylarkModuleDoc toplevelModuleDoc = modules.get( SkylarkDocumentationCollector.getTopLevelModule().name()); |