8232639: Change module graph images to use SVG instead of PNG format.
authorjjg
Mon, 21 Oct 2019 11:35:36 -0700
changeset 58726 449555c346d9
parent 58725 190ec5fae2af
child 58727 fa1f838b5486
8232639: Change module graph images to use SVG instead of PNG format. Reviewed-by: mchung, ihse
make/Docs.gmk
make/jdk/src/classes/build/tools/taglet/ModuleGraph.java
--- a/make/Docs.gmk	Mon Oct 21 14:26:10 2019 -0400
+++ b/make/Docs.gmk	Mon Oct 21 11:35:36 2019 -0700
@@ -192,26 +192,26 @@
 ################################################################################
 # Functions
 
-# Helper function for creating a png file from a dot file generated by the
+# Helper function for creating a svg file from a dot file generated by the
 # GenGraphs tool.
 # param 1: SetupJavadocGeneration namespace ($1)
 # param 2: module name
 #
-define setup_gengraph_dot_to_png
+define setup_gengraph_dot_to_svg
   $1_$2_DOT_SRC :=  $$($1_GENGRAPHS_DIR)/$2.dot
-  $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.png
+  $1_$2_SVG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.svg
 
-    # For each module needing a graph, create a png file from the dot file
+    # For each module needing a graph, create a svg file from the dot file
     # generated by the GenGraphs tool and store it in the target dir.
-    $$(eval $$(call SetupExecute, gengraphs_png_$1_$2, \
+    $$(eval $$(call SetupExecute, gengraphs_svg_$1_$2, \
         INFO := Running dot for module graphs for $2, \
         DEPS := $$(gengraphs_$1_TARGET), \
-        OUTPUT_FILE := $$($1_$2_PNG_TARGET), \
+        OUTPUT_FILE := $$($1_$2_SVG_TARGET), \
         SUPPORT_DIR := $$($1_GENGRAPHS_DIR), \
-        COMMAND := $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC), \
+        COMMAND := $$(DOT) -Tsvg -o $$($1_$2_SVG_TARGET) $$($1_$2_DOT_SRC), \
     ))
 
-  $1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET)
+  $1_MODULEGRAPH_TARGETS += $$($1_$2_SVG_TARGET)
 endef
 
 # Helper function to create the overview.html file to use with the -overview
@@ -282,7 +282,7 @@
 
   ifeq ($$(ENABLE_FULL_DOCS), true)
     # Tell the ModuleGraph taglet to generate html links to soon-to-be-created
-    # png files with module graphs.
+    # svg files with module graphs.
     $1_JAVA_ARGS += -DenableModuleGraph=true
   endif
 
@@ -362,8 +362,8 @@
   $1_JAVADOC_TARGETS := $$(javadoc_$1_TARGET)
 
   ifeq ($$(ENABLE_FULL_DOCS), true)
-    # We have asked ModuleGraph to generate links to png files. Now we must
-    # produce the png files.
+    # We have asked ModuleGraph to generate links to svg files. Now we must
+    # produce the svg files.
 
     # Locate which modules has the @moduleGraph tag in their module-info.java
     $1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \
@@ -388,11 +388,11 @@
             --dot-attributes $$(GENGRAPHS_PROPS), \
     ))
 
-    # For each module needing a graph, create a png file from the dot file
+    # For each module needing a graph, create a svg file from the dot file
     # generated by the GenGraphs tool and store it in the target dir.
     # They will depend on gengraphs_$1_TARGET, and will be added to $1.
     $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \
-      $$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \
+      $$(eval $$(call setup_gengraph_dot_to_svg,$1,$$m)) \
     )
   endif
 endef
--- a/make/jdk/src/classes/build/tools/taglet/ModuleGraph.java	Mon Oct 21 14:26:10 2019 -0400
+++ b/make/jdk/src/classes/build/tools/taglet/ModuleGraph.java	Mon Oct 21 11:35:36 2019 -0700
@@ -64,7 +64,7 @@
         }
 
         String moduleName = ((ModuleElement) element).getQualifiedName().toString();
-        String imageFile = "module-graph.png";
+        String imageFile = "module-graph.svg";
         int thumbnailHeight = -1;
         String hoverImage = "";
         if (!moduleName.equals("java.base")) {