aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
diff options
context:
space:
mode:
authorGravatar Francois-Rene Rideau <tunes@google.com>2015-04-17 15:31:59 +0000
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2015-04-17 15:43:19 +0000
commit76023b9180d7a18defc526126a943fab684971dc (patch)
tree0b65fe1803ebfb3eeff439a2d354987889044bd7 /src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
parenta8628bfffa72994759e4ac8bb45f317c4f33c05d (diff)
More skylark function cleanups
-- MOS_MIGRATED_REVID=91407816
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.java22
1 files changed, 12 insertions, 10 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 4c9743c7c7..d27e71da40 100644
--- a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
+++ b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java
@@ -19,6 +19,7 @@ import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
+import com.google.common.io.Files;
import com.google.devtools.build.docgen.SkylarkJavaInterfaceExplorer.SkylarkBuiltinMethod;
import com.google.devtools.build.docgen.SkylarkJavaInterfaceExplorer.SkylarkJavaMethod;
import com.google.devtools.build.docgen.SkylarkJavaInterfaceExplorer.SkylarkModuleDoc;
@@ -36,10 +37,10 @@ import com.google.devtools.build.lib.syntax.SkylarkModule;
import java.io.BufferedWriter;
import java.io.File;
-import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
+import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@@ -70,7 +71,8 @@ public class SkylarkDocumentationProcessor {
public void generateDocumentation(String outputPath) throws IOException,
BuildEncyclopediaDocException {
File skylarkDocPath = new File(outputPath);
- try (BufferedWriter bw = new BufferedWriter(new FileWriter(skylarkDocPath))) {
+ try (BufferedWriter bw = new BufferedWriter(
+ Files.newWriter(skylarkDocPath, StandardCharsets.UTF_8))) {
if (USE_TEMPLATE) {
bw.write(SourceFileReader.readTemplateContents(DocgenConsts.SKYLARK_BODY_TEMPLATE,
ImmutableMap.<String, String>of(
@@ -130,7 +132,7 @@ public class SkylarkDocumentationProcessor {
.append(annotation.doc())
.append("\n");
sb.append("<ul>");
- // Sort Java and SkylarkBuiltin methods together. The map key is only used for sorting.
+ // Sort Java and Skylark builtin methods together. The map key is only used for sorting.
TreeMap<String, Object> methodMap = new TreeMap<>();
for (SkylarkJavaMethod method : module.getJavaMethods()) {
methodMap.put(method.name + method.method.getParameterTypes().length, method);
@@ -291,13 +293,13 @@ public class SkylarkDocumentationProcessor {
? " (" + getTypeAnchor(param.type()) + ")"
: " (" + getTypeAnchor(param.type(), param.generic1()) + ")");
sb.append(String.format("\t<li id=\"modules.%s.%s.%s\"><code>%s%s</code>: ",
- moduleId,
- methodName,
- param.name(),
- param.name(),
- paramType))
- .append(param.doc())
- .append("\n\t</li>\n");
+ moduleId,
+ methodName,
+ param.name(),
+ param.name(),
+ paramType))
+ .append(param.doc())
+ .append("\n\t</li>\n");
}
sb.append("</ul>\n");
}