aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlwin Esch <alwin.esch@web.de>2021-11-02 23:42:46 +0100
committerGitHub <noreply@github.com>2021-11-02 23:42:46 +0100
commit2b10a2140faef953cc1f1d0c7d7bc1fe2749b7e2 (patch)
treedf5ed6809b4b8ef243c59674ca971e55d631c604 /docs
parent8f05e5f348c35325c0622e2fe9e6249f7cc08436 (diff)
parente9cc8357fb5183e46d68812fbb44e342f754cc56 (diff)
Merge pull request #20432 from AlwinEsch/sync-doxygen
[docs][addons] sync doxygen between Kodi and addons
Diffstat (limited to 'docs')
-rw-r--r--docs/doxygen/Doxyfile.doxy39
-rw-r--r--docs/doxygen/kodi_values.doxy34
2 files changed, 40 insertions, 33 deletions
diff --git a/docs/doxygen/Doxyfile.doxy b/docs/doxygen/Doxyfile.doxy
index 5a83241fbc..b0e0859dc9 100644
--- a/docs/doxygen/Doxyfile.doxy
+++ b/docs/doxygen/Doxyfile.doxy
@@ -13,6 +13,10 @@
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
+# This includes a own file where used on Kodi itself and by kodi-dev-kit.
+# Also used to have on new releases better overview which parts need update.
+@INCLUDE = ./kodi_values.doxy
+
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
@@ -38,7 +42,7 @@ PROJECT_NAME = "Kodi Documentation"
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = 20.0
+# PROJECT_NUMBER done by ./kodi_values.doxy
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -238,38 +242,7 @@ TAB_SIZE = 2
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
-ALIASES = "table_start=<table width=\"100%\" style=\"border\" bgcolor=\"576f9f\" border=\"0\">" \
- "table_end=</table>" \
- "table_h2_l{2}=<tr bgcolor= 576f9f><th width= 40% align=left>\1</th><th width= 60% align=left>\2</th></tr>" \
- "table_row2_l{2}=<tr bgcolor=white><td width= 40% align=left>\1</td><td width= 60% align=left>\2</td></tr>" \
- "table_h3{3}=<tr bgcolor=576f9f><th width=30% align=left valign=middle><b>\1</b></th><th width=10% align=left valign=middle><b>\2</b></th><th width=60% align=left valign=middle><span><b>\3</b></span></th></tr>" \
- "table_row3{3}=\htmlonly<tr bgcolor=white><td width= 30% align=left>\endhtmlonly\1\htmlonly</td><td width= 10% align=left>\endhtmlonly\2\htmlonly</td><td width= 60% align=left>\endhtmlonly\3\htmlonly</td></tr>\endhtmlonly" \
- "python_func{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4><hr> \endhtmlonly" \
- "python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \
- "python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
- "python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \
- "doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
- "python_removed_function{3}=\htmlonly <dl class=\"reflist\"><dt>Member <a class=\"el\" href=\"\2\">\1</a> (...)</dt><dd>\3</dd></dl>\endhtmlonly" \
- "cpp_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
- "cpp_namespace{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Namespace: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
- "python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
- "python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
- "python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
- "python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
- "python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
- "python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\"" \
- "python_v18=\xrefitem python_v18 \"v18 Python API changes\" \"\"" \
- "python_v19=\xrefitem python_v19 \"v19 Python API changes\" \"\"" \
- "python_v20=\xrefitem python_v20 \"v20 Python API changes\" \"\"" \
- "skinning_v12=\xrefitem skinning_v12 \"v12 Skinning engine changes\" \"\"" \
- "skinning_v13=\xrefitem skinning_v13 \"v13 Skinning engine changes\" \"\"" \
- "skinning_v14=\xrefitem skinning_v14 \"v14 Skinning engine changes\" \"\"" \
- "skinning_v15=\xrefitem skinning_v15 \"v15 Skinning engine changes\" \"\"" \
- "skinning_v16=\xrefitem skinning_v16 \"v16 Skinning engine changes\" \"\"" \
- "skinning_v17=\xrefitem skinning_v17 \"v17 Skinning engine changes\" \"\"" \
- "skinning_v18=\xrefitem skinning_v18 \"v18 Skinning engine changes\" \"\"" \
- "skinning_v19=\xrefitem skinning_v19 \"v19 Skinning engine changes\" \"\""
- "skinning_v20=\xrefitem skinning_v20 \"v20 Skinning engine changes\" \"\""
+# ALIASES done by ./kodi_values.doxy
# 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"
diff --git a/docs/doxygen/kodi_values.doxy b/docs/doxygen/kodi_values.doxy
new file mode 100644
index 0000000000..d17f670ff7
--- /dev/null
+++ b/docs/doxygen/kodi_values.doxy
@@ -0,0 +1,34 @@
+PROJECT_NUMBER = 20.0
+
+ALIASES = "table_start=<table width=\"100%\" style=\"border\" bgcolor=\"576f9f\" border=\"0\">" \
+ "table_end=</table>" \
+ "table_h2_l{2}=<tr bgcolor= 576f9f><th width= 40% align=left>\1</th><th width= 60% align=left>\2</th></tr>" \
+ "table_row2_l{2}=<tr bgcolor=white><td width= 40% align=left>\1</td><td width= 60% align=left>\2</td></tr>" \
+ "table_h3{3}=<tr bgcolor=576f9f><th width=30% align=left valign=middle><b>\1</b></th><th width=10% align=left valign=middle><b>\2</b></th><th width=60% align=left valign=middle><span><b>\3</b></span></th></tr>" \
+ "table_row3{3}=\htmlonly<tr bgcolor=white><td width= 30% align=left>\endhtmlonly\1\htmlonly</td><td width= 10% align=left>\endhtmlonly\2\htmlonly</td><td width= 60% align=left>\endhtmlonly\3\htmlonly</td></tr>\endhtmlonly" \
+ "python_func{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4><hr> \endhtmlonly" \
+ "python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \
+ "python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
+ "python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \
+ "python_removed_function{3}=\htmlonly <dl class=\"reflist\"><dt>Member <a class=\"el\" href=\"\2\">\1</a> (...)</dt><dd>\3</dd></dl>\endhtmlonly" \
+ "cpp_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
+ "cpp_namespace{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Namespace: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
+ "doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
+ "python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
+ "python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
+ "python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
+ "python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
+ "python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
+ "python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\"" \
+ "python_v18=\xrefitem python_v18 \"v18 Python API changes\" \"\"" \
+ "python_v19=\xrefitem python_v19 \"v19 Python API changes\" \"\"" \
+ "python_v20=\xrefitem python_v20 \"v20 Python API changes\" \"\"" \
+ "skinning_v12=\xrefitem skinning_v12 \"v12 Skinning engine changes\" \"\"" \
+ "skinning_v13=\xrefitem skinning_v13 \"v13 Skinning engine changes\" \"\"" \
+ "skinning_v14=\xrefitem skinning_v14 \"v14 Skinning engine changes\" \"\"" \
+ "skinning_v15=\xrefitem skinning_v15 \"v15 Skinning engine changes\" \"\"" \
+ "skinning_v16=\xrefitem skinning_v16 \"v16 Skinning engine changes\" \"\"" \
+ "skinning_v17=\xrefitem skinning_v17 \"v17 Skinning engine changes\" \"\"" \
+ "skinning_v18=\xrefitem skinning_v18 \"v18 Skinning engine changes\" \"\"" \
+ "skinning_v19=\xrefitem skinning_v19 \"v19 Skinning engine changes\" \"\"" \
+ "skinning_v20=\xrefitem skinning_v20 \"v20 Skinning engine changes\" \"\""