Doxygen: add build option to use svg instead of png files for graphs

Differential Revision: http://reviews.llvm.org/D11994

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@245256 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/CMake.rst b/docs/CMake.rst
index b6dd83850ff27442ca12b87ae6e5772aa5138435..909fc04248c77784471122f65a021f9c415a884d 100644 (file)
--- a/docs/CMake.rst
+++ b/docs/CMake.rst
@@ -387,6 +387,10 @@ LLVM-specific variables
   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no
   effect.
 
+**LLVM_DOXYGEN_SVG**:BOOL
+  Uses .svg files instead of .png files for graphs in the Doxygen output.
+  Defaults to OFF.
+
 **LLVM_ENABLE_SPHINX**:BOOL
   If enabled CMake will search for the ``sphinx-build`` executable and will make
   the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index e02fcd9a4d63ab2e45907eb639df11b18be16e7a..eaa175062b614dc6de3cf9baad6f12f4da8bea68 100644 (file)
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -56,6 +56,14 @@ if (LLVM_ENABLE_DOXYGEN)
     set(llvm_doxygen_qhp_cust_filter_attrs "")
   endif()
   
+  option(LLVM_DOXYGEN_SVG
+    "Use svg instead of png files for doxygen graphs." OFF)
+  if (LLVM_DOXYGEN_SVG)
+    set(DOT_IMAGE_FORMAT "svg")
+  else()
+    set(DOT_IMAGE_FORMAT "png")
+  endif()
+
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
     ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
 
@@ -73,6 +81,7 @@ if (LLVM_ENABLE_DOXYGEN)
   set(llvm_doxygen_qhelpgenerator_path)
   set(llvm_doxygen_qhp_cust_filter_name)
   set(llvm_doxygen_qhp_cust_filter_attrs)
+  set(DOT_IMAGE_FORMAT)
 
   add_custom_target(doxygen-llvm
     COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg

diff --git a/docs/Makefile b/docs/Makefile
index c9d2477c0af29f3d516a51bd267ca56786a91211..da649bc887321200d01de23c8aef7e23785bd81e 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -31,6 +31,7 @@ $(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
          -e 's/@llvm_doxygen_qhp_cust_filter_name@//g' \
          -e 's/@llvm_doxygen_qhp_namespace@//g' \
          -e 's/@searchengine_url@//g' \
+         -e 's/@DOT_IMAGE_FORMAT@/png/g' \
          > $@
 endif
 

diff --git a/docs/doxygen.cfg.in b/docs/doxygen.cfg.in
index d8c4051e5637d9eb55184f37fa51353c9b553205..5c70db0332d55ce2ea99510dbd2a8402fcb4444f 100644 (file)
--- a/docs/doxygen.cfg.in
+++ b/docs/doxygen.cfg.in
@@ -2205,7 +2205,7 @@ DIRECTORY_GRAPH        = YES
 # The default value is: png.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_IMAGE_FORMAT       = png
+DOT_IMAGE_FORMAT       = @DOT_IMAGE_FORMAT@
 
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 # enable generation of interactive SVG images that allow zooming and panning.