# 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
# Shows all lines between public and private *inclusive*.
ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3"
+# <DALi Doxygen Tagging Rule>
+#
+# 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.
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \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
# 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
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = main.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
# 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
# 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
# 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
# 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
projects / platform / core / uifw / dali-toolkit.git / blobdiff