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=1b58120a1ea92ebdb604f2f7c54bc3e3812f8914;hp=d7c78f90a6cf19f119d0c4118510e3cb8f49a963;hb=e9a5063796f71246b3b4d8b419cf8b308689f7ee;hpb=b398ab61279f2fe1e96f7567cecb123c25e2edb1 diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index d7c78f9..1b58120 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = Dali +PROJECT_NAME = DALi # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -236,6 +236,157 @@ 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 += DEPRECATED_1_0="@deprecated Deprecated since 1.0" +ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1" +ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2" + +ALIASES += PLATFORM="" +ALIASES += PRIVLEVEL_PLATFORM="" +ALIASES += PRIVLEVEL_PUBLIC="" +ALIASES += PRIVILEGE_KEYGRAB="" +ALIASES += PRIVILEGE_DISPLAY="" +ALIASES += REMARK_INTERNET="" + +############################################ +## 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" + +## 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="@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 += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address." + + # 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 +771,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 @@ -758,9 +909,14 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = @DOXYGEN_DOCS_DIR@/content \ - ../../../../dali-toolkit/dali-toolkit/public-api \ - ../../../automated-tests/README.md \ - @prefix@/include/dali + @prefix@/include/dali/doc/dali-core-doc.h \ + @prefix@/include/dali/doc/dali-adaptor-doc.h \ + ../../../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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -780,38 +936,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. @@ -1309,7 +1436,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 @@ -1317,7 +1444,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 @@ -1356,6 +1483,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