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=72ed846a08a9bf7d7760a3c27845caa9b4906d5b;hp=bbb08c2d20a914f6d2943eaebd6041696102ebcc;hb=56a6cfdd724ac6f24febf2767ab7a3e6a081b7bc;hpb=659d0ae8e8c828cb46fad7448b37ff9b7062819d diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index bbb08c2..72ed846 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,137 @@ 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 += DEPRECATED_1_0="@deprecated Deprecated since 1.0" +ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1" + +ALIASES += PLATFORM="" +ALIASES += PRIVLEVEL_PLATFORM="" +ALIASES += PRIVILEGE_KEYGRAB="" + +############################################ +## 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" + +## 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 += PLATFORM="@platform" +#ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform" +#ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab" + + # 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. @@ -758,9 +889,12 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. 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/public-api \ ../../../../dali-toolkit/dali-toolkit/public-api \ - ../../../automated-tests/README.md \ - @prefix@/include/dali + ../../../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 @@ -1120,7 +1254,7 @@ HTML_STYLESHEET = # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = dali_doxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note