From: Logan Chien Date: Thu, 12 Mar 2015 17:25:01 +0000 (+0000) Subject: [autoconf] Refine doxygen document options. X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=4c841fd7f4e9a1f82d37e7291b29b48834f1d656;p=oota-llvm.git [autoconf] Refine doxygen document options. This CL adds --enable-doxygen-search to enable doxygen search engine and --enable-doxygen-qt-help to enable the Qt help file generation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232062 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/autoconf/configure.ac b/autoconf/configure.ac index 06abf58aab0..19f7a2e20c8 100644 --- a/autoconf/configure.ac +++ b/autoconf/configure.ac @@ -801,11 +801,139 @@ AC_ARG_ENABLE(doxygen, enableval=default) case "$enableval" in yes) AC_SUBST(ENABLE_DOXYGEN,[1]) ;; - no) AC_SUBST(ENABLE_DOXYGEN,[0]) ;; - default) AC_SUBST(ENABLE_DOXYGEN,[0]) ;; + no|default) AC_SUBST(ENABLE_DOXYGEN,[0]) ;; *) AC_MSG_ERROR([Invalid setting for --enable-doxygen. Use "yes" or "no"]) ;; esac +dnl Allow enablement of doxygen search engine +AC_ARG_ENABLE(doxygen-search, + AS_HELP_STRING([--enable-doxygen-search], + [Enable doxygen search support (default is NO)]),, + enableval=default) +ENABLE_DOXYGEN_SEARCH="$enableval" + +case "$enableval" in + yes|no|default) ;; + *) AC_MSG_ERROR([Invalid setting for --enable-doxygen-search. Use "yes" or "no"]) ;; +esac + +AC_ARG_ENABLE(doxygen-external-search, + AS_HELP_STRING([--enable-doxygen-external-search], + [Enable doxygen exteranl search (default is NO)]),, + enableval=default) +ENABLE_DOXYGEN_EXTERNAL_SEARCH="$enableval" + +case "$enableval" in + yes) + dnl To match with the CMake behavior, enable doxygen when + dnl --enable-doxygen-external-search is enabled. + case "$ENABLE_DOXYGEN_SEARCH" in + yes|default) ENABLE_DOXYGEN_SEARCH="yes" ;; + no) AC_MSG_ERROR([The option --enable-doxygen-external-search requires --enable-doxygen-search]) ;; + esac + ;; + no|default) ;; + *) AC_MSG_ERROR([Invalid setting for --enable-doxygen-external-search. Use "yes" or "no"]) ;; +esac + +AC_ARG_WITH(doxygen-search-engine-url, + AS_HELP_STRING([--with-doxygen-search-engine-url], + [Specify the external search engine for doxygen]),,) +WITH_DOXYGEN_SEARCH_ENGINE_URL="$withval" + +AC_ARG_WITH(doxygen-search-mappings, + AS_HELP_STRING([--with-doxygen-search-mappings], + [Specify the extra search mapping for doxygen]),,) +WITH_DOXYGEN_SEARCH_MAPPINGS="$withval" + +case "$ENABLE_DOXYGEN_SEARCH" in + yes) + if test "$ENABLE_DOXYGEN" = "0" ; then + AC_MSG_ERROR([The option --enable-doxygen-search requires --enable-doxygen.]) + fi + + AC_SUBST(enable_searchengine,[YES]) + + case "$ENABLE_DOXYGEN_EXTERNAL_SEARCH" in + yes) + AC_SUBST(enable_external_search,[YES]) + AC_SUBST(enable_server_based_search,[YES]) + AC_SUBST(searchengine_url,[$WITH_DOXYGEN_SEARCH_ENGINE_URL]) + AC_SUBST(extra_search_mappings,[$WITH_DOXYGEN_SEARCH_MAPPINGS]) + ;; + + no|default) + AC_SUBST(enable_external_search,[NO]) + AC_SUBST(enable_server_based_search,[NO]) + AC_SUBST(searchengine_url,[]) + AC_SUBST(extra_search_mappings,[]) + ;; + esac + ;; + + no|default) + AC_SUBST(enable_searchengine,[NO]) + AC_SUBST(searchengine_url,[]) + AC_SUBST(enable_server_based_search,[NO]) + AC_SUBST(enable_external_search,[NO]) + AC_SUBST(extra_search_mappings,[]) + ;; + + *) + AC_MSG_ERROR([Invalid setting for --enable-doxygen-search. Use "yes" or "no"]) + ;; +esac + +dnl Allow enablement of doxygen generated Qt help files +AC_ARG_ENABLE(doxygen-qt-help, + AS_HELP_STRING([--enable-doxygen-qt-help], + [Build Qt help files (default is NO)]),, + enableval=default) +case "$enableval" in + yes) + if test "$ENABLE_DOXYGEN" = "0" ; then + AC_MSG_ERROR([The option --enable-doxygen-qt-help requires --enable-doxygen.]) + fi + + AC_PATH_PROG(QHELPGENERATOR, [qhelpgenerator], [qhelpgenerator]) + + dnl Qt help file for llvm doxygen documentation + AC_SUBST(llvm_doxygen_generate_qhp,[YES]) + AC_SUBST(llvm_doxygen_qch_filename,[org.llvm.qch]) + AC_SUBST(llvm_doxygen_qhp_namespace,[org.llvm]) + AC_SUBST(llvm_doxygen_qhelpgenerator_path,[$QHELPGENERATOR]) + AC_SUBST(llvm_doxygen_qhp_cust_filter_name,[$PACKAGE_STRING]) + AC_SUBST(llvm_doxygen_qhp_cust_filter_attrs,[$PACKAGE_NAME,$PACKAGE_VERSION]) + + dnl Qt help file for clang doxygen documentation + AC_SUBST(clang_doxygen_generate_qhp,[YES]) + AC_SUBST(clang_doxygen_qch_filename,[org.llvm.clang.qch]) + AC_SUBST(clang_doxygen_qhp_namespace,[org.llvm.clang]) + AC_SUBST(clang_doxygen_qhelpgenerator_path,[$QHELPGENERATOR]) + AC_SUBST(clang_doxygen_qhp_cust_filter_name,[Clang $PACKAGE_VERSION]) + AC_SUBST(clang_doxygen_qhp_cust_filter_attrs,[Clang,$PACKAGE_VERSION]) + ;; + + no|default) + AC_SUBST(llvm_doxygen_generate_qhp,[NO]) + AC_SUBST(llvm_doxygen_qch_filename,[]) + AC_SUBST(llvm_doxygen_qhp_namespace,[]) + AC_SUBST(llvm_doxygen_qhelpgenerator_path,[]) + AC_SUBST(llvm_doxygen_qhp_cust_filter_name,[]) + AC_SUBST(llvm_doxygen_qhp_cust_filter_attrs,[]) + + AC_SUBST(clang_doxygen_generate_qhp,[NO]) + AC_SUBST(clang_doxygen_qch_filename,[]) + AC_SUBST(clang_doxygen_qhp_namespace,[]) + AC_SUBST(clang_doxygen_qhelpgenerator_path,[]) + AC_SUBST(clang_doxygen_qhp_cust_filter_name,[Clang $PACKAGE_VERSION]) + AC_SUBST(clang_doxygen_qhp_cust_filter_attrs,[Clang,$PACKAGE_VERSION]) + ;; + + *) + AC_MSG_ERROR([Invalid setting for --enable-doxygen-qt-help. Use "yes" or "no"]) ;; +esac + dnl Allow disablement of threads AC_ARG_ENABLE(threads, AS_HELP_STRING([--enable-threads], diff --git a/docs/Makefile b/docs/Makefile index dcf2f39e2c5..7d0ddbb7362 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -16,15 +16,22 @@ DOXYGEN = doxygen $(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in cat $< | sed \ - -e 's/@abs_top_srcdir@/../g' \ -e 's/@DOT@/dot/g' \ -e 's/@PACKAGE_VERSION@/mainline/' \ -e 's/@abs_top_builddir@/../g' \ + -e 's/@abs_top_srcdir@/../g' \ + -e 's/@enable_external_search@/NO/g' \ -e 's/@enable_searchengine@/NO/g' \ - -e 's/@searchengine_url@//g' \ -e 's/@enable_server_based_search@/NO/g' \ - -e 's/@enable_external_search@/NO/g' \ - -e 's/@extra_search_mappings@//g' > $@ + -e 's/@extra_search_mappings@//g' \ + -e 's/@llvm_doxygen_generate_qhp@//g' \ + -e 's/@llvm_doxygen_qch_filename@//g' \ + -e 's/@llvm_doxygen_qhelpgenerator_path@//g' \ + -e 's/@llvm_doxygen_qhp_cust_filter_attrs@//g' \ + -e 's/@llvm_doxygen_qhp_cust_filter_name@//g' \ + -e 's/@llvm_doxygen_qhp_namespace@//g' \ + -e 's/@searchengine_url@//g' \ + > $@ endif include $(LEVEL)/Makefile.common