From: Eunki Hong Date: Fri, 27 Jan 2023 15:43:41 +0000 (+0900) Subject: Doxygen check version and block low version X-Git-Tag: dali_2.2.12~6^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F18%2F287418%2F3;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git Doxygen check version and block low version Some option did not allow to be used some low version. This patch make dali.doxy.in block them if version is low. Change-Id: I5ca620113e7080a261cf84976d2619e231b04bab Signed-off-by: Eunki Hong --- diff --git a/build/tizen/CMakeLists.txt b/build/tizen/CMakeLists.txt index 6313fc9..a1f4efd 100644 --- a/build/tizen/CMakeLists.txt +++ b/build/tizen/CMakeLists.txt @@ -34,7 +34,7 @@ OPTION(ENABLE_LINK_TEST "Enable the link test" ON) OPTION(INSTALL_DOXYGEN_DOC "Install doxygen doc" ON) OPTION(CONFIGURE_AUTOMATED_TESTS "Configure automated tests" ON) OPTION(USE_DEFAULT_RESOURCE_DIR "Whether to use the default resource folders. Otherwise set environment variables for DALI_IMAGE_DIR, DALI_SOUND_DIR, DALI_STYLE_DIR, DALI_STYLE_IMAGE_DIR and DALI_DATA_READ_ONLY_DIR" ON) -OPTION(BUILD_SCENE3D "Whether to build dali-scene3d." ON) +OPTION(BUILD_SCENE3D "Whether to build dali-scene3d." ON) IF( ENABLE_PKG_CONFIGURE ) FIND_PACKAGE( PkgConfig REQUIRED ) @@ -565,6 +565,17 @@ IF( DOXYGEN_FOUND ) SET( doxygenEnabled ON ) # 'prefix' is used by doxygen in-files. SET( prefix ${PREFIX} ) + + # Some doxygen properties not allowed at low version. + # We need to get doxygen version, and block in doxygen in-files. + EXECUTE_PROCESS( COMMAND bash -c "${DOXYGEN_EXECUTABLE} --version" OUTPUT_VARIABLE DOXYGEN_VERSION ) + + IF(${DOXYGEN_VERSION} VERSION_LESS "1.9.1") + SET( DOXYGEN_VERSION_LESS_1_9_1_BLOCKED "# ") + ELSE() + SET( DOXYGEN_VERSION_LESS_1_9_1_BLOCKED "") + ENDIF() + SET( DOXYGEN_DOCS_DIR ${ROOT_SRC_DIR}/docs ) SET( DOXYGEN_ROOT_DIR ${ROOT_SRC_DIR} ) SET( DOXYGEN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs ) diff --git a/build/tizen/docs-internal/dali-internal.doxy.in b/build/tizen/docs-internal/dali-internal.doxy.in index 1807df0..cfb7335 100644 --- a/build/tizen/docs-internal/dali-internal.doxy.in +++ b/build/tizen/docs-internal/dali-internal.doxy.in @@ -1,4 +1,8 @@ -# Doxyfile 1.8.11 +# Doxyfile @DOXYGEN_VERSION@ +# Note : Some option need to be blocked if version is lower than 1.9.1. +# See how "DOXYGEN_VERSION_LESS_1_9_1_BLOCKED" defined in CMakeList.txt. + +# TODO : Need to update this file use updated doxygen 1.9.1 format # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -357,6 +361,8 @@ ALIASES += SINCE_1_3="@since 1.3" ALIASES += SINCE_1_4="@since 1.4" ALIASES += SINCE_1_9="@since 1.9" ALIASES += SINCE_2_0="@since 2.0" +ALIASES += SINCE_2_1="@since 2.1" +ALIASES += SINCE_2_2="@since 2.2" # Extra tags for Tizen 3.0 ALIASES += SINCE_1_2_2="@since 1.2.2" @@ -385,6 +391,8 @@ ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 1.3.39" ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 1.3.51" ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 1.4" ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 2.0" +ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 2.1" +ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 2.2" ALIASES += PLATFORM="" ALIASES += PRIVLEVEL_PLATFORM="" @@ -404,7 +412,9 @@ ALIASES += REMARK_RAWVIDEO="" #ALIASES += SINCE_1_3="\par Since:\n 5.0, DALi version 1.3" #ALIASES += SINCE_1_4="\par Since:\n 5.5, DALi version 1.4" #ALIASES += SINCE_1_9="\par Since:\n 6.0, DALi version 1.9" -#ALIASES += SINCE_2_0="\par Since:\n 6.0, DALi version 2.0" +#ALIASES += SINCE_2_0="\par Since:\n 6.5, DALi version 2.0" +#ALIASES += SINCE_2_1="\par Since:\n 7.0, DALi version 2.1" +#ALIASES += SINCE_2_2="\par Since:\n 7.5, DALi version 2.2" ## Extra tags for Tizen 3.0 #ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2" @@ -434,6 +444,9 @@ ALIASES += REMARK_RAWVIDEO="" #ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 5.5, DALi version 1.3.39" #ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 5.5, DALi version 1.3.51" #ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 5.5, DALi version 1.4" +#ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 6.5, DALi version 2.0" +#ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 7.0, DALi version 2.1" +#ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 7.5, DALi version 2.2" #ALIASES += PLATFORM="@platform" #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform" diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 921ee6e..99eb3e4 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -1,9 +1,6 @@ -# Doxyfile 1.8.11 -# Note : If you want to upgrade Doxyfile into 1.9.1 -# Find "###1.9.1###" and remove these comments. -# For example, -# ###1.9.1###PYTHON_DOCSTRING = YES --> -# PYTHON_DOCSTRING = YES +# Doxyfile @DOXYGEN_VERSION@ +# Note : Some option need to be blocked if version is lower than 1.9.1. +# See how "DOXYGEN_VERSION_LESS_1_9_1_BLOCKED" defined in CMakeList.txt. # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -238,7 +235,7 @@ MULTILINE_CPP_IS_BRIEF = NO # documentation blocks is shown as doxygen documentation. # The default value is: YES. -###1.9.1###PYTHON_DOCSTRING = YES +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ PYTHON_DOCSTRING = YES # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. @@ -690,7 +687,7 @@ LOOKUP_CACHE_SIZE = 0 # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. -###1.9.1###NUM_PROC_THREADS = 1 +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ NUM_PROC_THREADS = 1 #--------------------------------------------------------------------------- # Build related configuration options @@ -760,7 +757,7 @@ EXTRACT_ANON_NSPACES = NO # parameters remain unnamed in the output. # The default value is: YES. -###1.9.1###RESOLVE_UNNAMED_PARAMS = YES +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ RESOLVE_UNNAMED_PARAMS = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these @@ -1353,7 +1350,7 @@ CLANG_ASSISTED_PARSING = NO # YES then doxygen will add the directory of each input to the include path. # The default value is: YES. -###1.9.1###CLANG_ADD_INC_PATHS = YES +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ CLANG_ADD_INC_PATHS = YES # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that @@ -1806,7 +1803,7 @@ EXT_LINKS_IN_WINDOW = NO # The default value is: png. # This tag requires that the tag GENERATE_HTML is set to YES. -###1.9.1###HTML_FORMULA_FORMAT = png +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ HTML_FORMULA_FORMAT = png # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful @@ -2639,7 +2636,7 @@ UML_LIMIT_NUM_FIELDS = 10 # The default value is: NO. # This tag requires that the tag UML_LOOK is set to YES. -###1.9.1###DOT_UML_DETAILS = NO +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_UML_DETAILS = NO # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters # to display on a single line. If the actual line length exceeds this threshold @@ -2648,7 +2645,7 @@ UML_LIMIT_NUM_FIELDS = 10 # Minimum value: 0, maximum value: 1000, default value: 17. # This tag requires that the tag HAVE_DOT is set to YES. -###1.9.1###DOT_WRAP_THRESHOLD = 17 +@DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_WRAP_THRESHOLD = 17 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their