X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=build%2Ftizen%2Fdocs%2Fdali.doxy.in;h=4fd92a7979f0aeebe265702978e55de07a5cc1e1;hp=3fa2e57ace01a87c7d9cf00e9f33ed0a4d2ddd9b;hb=eb79139bc2a16c0e3a6953f736bfee5ad8b46bae;hpb=5c07fde9dd6a022e2080c871994499e56eff89aa diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 3fa2e57..4fd92a7 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -236,6 +236,170 @@ ALIASES = # Shows all lines between public and private *inclusive*. ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3" +# +# +# Use @SINCE_1_0, @SINCE_1_1, ... instead of @since, +# and use @DEPRECATED_1_0, @DEPRECATED_1_1, ... instead of @deprecated. +# It enables integrated management of version tagging between +# the open source DALi API reference and Tizen API reference. +# Using those tags with different ALIASES settings in each doxygen config file allows us +# to generate two versions of "Since" and "Deprecated" generated output +# from one set of public header files. +# +# If you need a newer version number like @SINCE_1_5 or @SINCE_2_0, just add new ALIASES for it. +# +# ##################################################3 +# # Guide for Open Source DALi API Reference +# +# ### @SINCE example: +# [some-public-header.h] +# /** +# * ... +# * @SINCE_1_0.1 +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# ... +# Since: +# 1.0.1 +# +# ### @DEPRECATED example 1: +# [some-public-header.h] +# /** +# * @DEPRECATED_1_0.3 +# * ... +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# Deprecated: +# Deprecated since 1.0.3 +# ... +# +# ### @DEPRECATED example 2: +# [some-public-header.h] +# ... +# /** +# * @DEPRECATED_1_0.3. Use SomeFunction2() instead. +# * ... +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# Deprecated: +# Deprecated since 1.0.3. Use SomeFunction2() instead. +# ... +# +# ##################################################3 +# # Guide for Tizen Native API Reference +# +# ### @SINCE example: +# [some-public-header.h] +# /** +# * ... +# * @SINCE_1_0.1 +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# ... +# Since: +# 2.4, DALi Version 1.0.1 +# +# ### @DEPRECATED example 1: +# [some-public-header.h] +# /** +# * @DEPRECATED_1_0.3 +# * ... +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# Deprecated: +# Deprecated since 3.0, DALi version 1.0.3 +# ... +# +# ### @DEPRECATED example 2: +# [some-public-header.h] +# ... +# /** +# * @DEPRECATED_1_0.3. Use SomeFunction2() instead. +# * ... +# */ +# void SomeFunction(); +# +# [generated html file] +# void SomeFunction() +# Deprecated: +# Deprecated since 3.0, DALi version 1.0.3. Use SomeFunction2() instead. +# ... + +########################################### +# For Open Source DALi API Reference +ALIASES += SINCE_1_0="@since 1.0" +ALIASES += SINCE_1_1="@since 1.1" +ALIASES += SINCE_1_2="@since 1.2" + +# Extra tags for Tizen 3.0 +ALIASES += SINCE_1_2_2="@since 1.2.2" +ALIASES += SINCE_1_2_4="@since 1.2.4" +ALIASES += SINCE_1_2_5="@since 1.2.5" +ALIASES += SINCE_1_2_10="@since 1.2.10" +ALIASES += SINCE_1_2_14="@since 1.2.14" +ALIASES += SINCE_1_2_32="@since 1.2.32" + +ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0" +ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1" +ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 1.2.8" +ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 1.2.10" +ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2" + +ALIASES += PLATFORM="" +ALIASES += PRIVLEVEL_PLATFORM="" +ALIASES += PRIVLEVEL_PUBLIC="" +ALIASES += PRIVILEGE_KEYGRAB="" +ALIASES += PRIVILEGE_DISPLAY="" +ALIASES += PRIVILEGE_WINDOW_PRIORITY="" +ALIASES += REMARK_INTERNET="" +ALIASES += REMARK_STORAGE="" + +############################################ +## For Tizen Native API Reference +#ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0" +#ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1" +#ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2" + +## Extra tags for Tizen 3.0 +#ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2" +#ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4" +#ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5" +#ALIASES += SINCE_1_2_10="\par Since:\n 3.0, DALi version 1.2.10" +#ALIASES += SINCE_1_2_14="\par Since:\n 3.0, DALi version 1.2.14" +#ALIASES += SINCE_1_2_32="\par Since:\n 3.0, DALi version 1.2.32" + +## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release. +## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0. +#ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0" +#ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1" +#ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 3.0, DALi version 1.2.8" +#ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 3.0, DALi version 1.2.10" +#ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2" + +#ALIASES += PLATFORM="@platform" +#ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform" +#ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public" +#ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab" +#ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display" +#ALIASES += PRIVILEGE_WINDOW_PRIORITY="\par Privilege:\n http://tizen.org/privilege/window.priority.set" +#ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address." +#ALIASES += REMARK_STORAGE="@remarks %http://tizen.org/privilege/mediastorage is needed if @a url is relevant to media storage. @remarks %http://tizen.org/privilege/externalstorage is needed if @a url is relevant to external storage." + # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. @@ -620,7 +784,7 @@ GENERATE_DEPRECATEDLIST= YES # sections, marked by \if ... \endif and \cond # ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = show_tizen_feature # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the @@ -760,9 +924,11 @@ WARN_LOGFILE = INPUT = @DOXYGEN_DOCS_DIR@/content \ @prefix@/include/dali/doc/dali-core-doc.h \ @prefix@/include/dali/doc/dali-adaptor-doc.h \ - ../../../../dali-toolkit/doc/dali-toolkit-doc.h \ - @prefix@/include/dali \ - ../../../../dali-toolkit/dali-toolkit/public-api \ + ../../../doc/dali-toolkit-doc.h \ + @prefix@/include/dali/public-api \ + @prefix@/include/dali/devel-api \ + ../../../dali-toolkit/public-api \ + ../../../dali-toolkit/devel-api \ ../../../automated-tests/README.md # This tag can be used to specify the character encoding of the source files @@ -783,38 +949,9 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ +FILE_PATTERNS = \ *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.vhd \ - *.vhdl + *.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -1312,7 +1449,7 @@ GENERATE_QHP = NO # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = +QCH_FILE = "Dali.qch" # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace @@ -1320,7 +1457,7 @@ QCH_FILE = # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_NAMESPACE = +QHP_NAMESPACE = "Dali" # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual @@ -1359,6 +1496,8 @@ QHP_SECT_FILTER_ATTRS = # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. +# Don't set this - there is a broken section tag in the resultant index.qhp +# that needs manually editing before running qhelpgenerator. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be