From 8d5e5d4170a18fabef5b87cf7b2230b77ae38a77 Mon Sep 17 00:00:00 2001 From: Hans Wennborg Date: Mon, 17 Aug 2015 23:24:17 +0000 Subject: [PATCH] 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 --- docs/CMake.rst | 4 ++++ docs/CMakeLists.txt | 9 +++++++++ docs/Makefile | 1 + docs/doxygen.cfg.in | 2 +- 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/CMake.rst b/docs/CMake.rst index b6dd83850ff..909fc04248c 100644 --- 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 e02fcd9a4d6..eaa175062b6 100644 --- 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 c9d2477c0af..da649bc8873 100644 --- 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 d8c4051e563..5c70db0332d 100644 --- 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. -- 2.34.1