aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/doxygen/Doxyfile.doxy39
-rw-r--r--docs/doxygen/kodi_values.doxy34
-rw-r--r--xbmc/addons/kodi-dev-kit/doxygen/Doxyfile83
-rw-r--r--xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/PVR.h27
-rw-r--r--xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Providers.h4
-rw-r--r--xbmc/guilib/_Controls.dox2
-rw-r--r--xbmc/interfaces/legacy/Addon.h3
-rw-r--r--xbmc/interfaces/legacy/InfoTagGame.h8
-rw-r--r--xbmc/interfaces/legacy/InfoTagPicture.h1
-rw-r--r--xbmc/interfaces/legacy/InfoTagVideo.h2
-rw-r--r--xbmc/interfaces/legacy/ListItem.h3
-rw-r--r--xbmc/interfaces/legacy/Player.h1
-rw-r--r--xbmc/interfaces/legacy/Settings.h20
13 files changed, 95 insertions, 132 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\" \"\""
diff --git a/xbmc/addons/kodi-dev-kit/doxygen/Doxyfile b/xbmc/addons/kodi-dev-kit/doxygen/Doxyfile
index 87307e571b..eea8a58b78 100644
--- a/xbmc/addons/kodi-dev-kit/doxygen/Doxyfile
+++ b/xbmc/addons/kodi-dev-kit/doxygen/Doxyfile
@@ -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 = ../../../../docs/doxygen/kodi_values.doxy
+
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
@@ -38,7 +42,7 @@ PROJECT_NAME = "Kodi Development"
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = 19.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,36 +242,7 @@ TAB_SIZE = 4
# "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" \
- "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\" \"\"" \
- "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\" \"\""
+# 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"
@@ -830,34 +805,38 @@ INPUT = main.txt \
Modules/modules_python.dox \
Skin/skin.dox \
../../../../cmake/scripts/common/AddonHelpers.dox \
- ../../../guilib/GUIRenderingControl.dox \
+ ../../../cores/RetroPlayer/guicontrols/GUIGameControl.dox \
+ ../../../pvr/guilib/GUIEPGGridContainer.dox \
../../../guilib/GUIButtonControl.dox \
+ ../../../guilib/GUIColorButtonControl.dox \
+ ../../../guilib/GUIControlGroup.dox \
../../../guilib/GUIEditControl.dox \
- ../../../epg/GUIEPGGridContainer.dox \
../../../guilib/GUIFadeLabelControl.dox \
../../../guilib/GUIFixedListContainer.dox \
- ../../../guilib/GUIControlGroup.dox \
- ../../../guilib/GUIListContainer.dox \
../../../guilib/GUIImage.dox \
../../../guilib/GUILabelControl.dox \
+ ../../../guilib/GUIListContainer.dox \
../../../guilib/GUIListGroup.dox \
../../../guilib/GUIMoverControl.dox \
../../../guilib/GUIMultiImage.dox \
../../../guilib/GUIPanelContainer.dox \
../../../guilib/GUIProgressControl.dox \
../../../guilib/GUIRadioButtonControl.dox \
+ ../../../guilib/GUIRangesControl.dox \
+ ../../../guilib/GUIRenderingControl.dox \
../../../guilib/GUIResizeControl.dox \
../../../guilib/GUIRSSControl.dox \
../../../guilib/GUIScrollBarControl.dox \
../../../guilib/GUISettingsSliderControl.dox \
- ../../../guilib/GUISpinControlEx.dox \
../../../guilib/GUISliderControl.dox \
../../../guilib/GUISpinControl.dox \
+ ../../../guilib/GUISpinControlEx.dox \
../../../guilib/GUITextBox.dox \
../../../guilib/GUIToggleButtonControl.dox \
../../../guilib/GUIVideoControl.dox \
../../../guilib/GUIVisualisationControl.dox \
../../../guilib/GUIWrappingListContainer.dox \
+ ../../../guilib/WindowIDs.dox \
../../../guilib/_Controls.dox \
../../../interfaces/builtins/AddonBuiltins.cpp \
../../../interfaces/builtins/AndroidBuiltins.cpp \
@@ -875,27 +854,31 @@ INPUT = main.txt \
../../../interfaces/builtins/SkinBuiltins.cpp \
../../../interfaces/builtins/SystemBuiltins.cpp \
../../../interfaces/builtins/WeatherBuiltins.cpp \
- ../../../interfaces/legacy/Keyboard.h \
- ../../../interfaces/legacy/InfoTagMusic.h \
- ../../../interfaces/legacy/InfoTagVideo.h \
../../../interfaces/legacy/Addon.h \
+ ../../../interfaces/legacy/Control.h \
../../../interfaces/legacy/Dialog.h \
- ../../../interfaces/legacy/ModuleXbmc.h \
- ../../../interfaces/legacy/ModuleXbmcgui.h \
+ ../../../interfaces/legacy/DrmCryptoSession.h \
../../../interfaces/legacy/File.h \
+ ../../../interfaces/legacy/InfoTagGame.h \
+ ../../../interfaces/legacy/InfoTagMusic.h \
+ ../../../interfaces/legacy/InfoTagPicture.h \
+ ../../../interfaces/legacy/InfoTagRadioRDS.h \
+ ../../../interfaces/legacy/InfoTagVideo.h \
+ ../../../interfaces/legacy/Keyboard.h \
../../../interfaces/legacy/ListItem.h \
- ../../../interfaces/legacy/Monitor.h \
- ../../../interfaces/legacy/ModuleXbmcvfs.h \
+ ../../../interfaces/legacy/ModuleXbmcgui.h \
+ ../../../interfaces/legacy/ModuleXbmc.h \
../../../interfaces/legacy/ModuleXbmcplugin.h \
- ../../../interfaces/legacy/InfoTagRadioRDS.h \
- ../../../interfaces/legacy/Window.h \
- ../../../interfaces/legacy/WindowDialog.h \
- ../../../interfaces/legacy/WindowXML.h \
- ../../../interfaces/legacy/Stat.h \
- ../../../interfaces/legacy/PlayList.h \
+ ../../../interfaces/legacy/ModuleXbmcvfs.h \
+ ../../../interfaces/legacy/Monitor.h \
../../../interfaces/legacy/Player.h \
+ ../../../interfaces/legacy/PlayList.h \
../../../interfaces/legacy/RenderCapture.h \
- ../../../interfaces/legacy/Control.h \
+ ../../../interfaces/legacy/Settings.h \
+ ../../../interfaces/legacy/Stat.h \
+ ../../../interfaces/legacy/WindowDialog.h \
+ ../../../interfaces/legacy/Window.h \
+ ../../../interfaces/legacy/WindowXML.h \
../../../interfaces/legacy/wsgi/WsgiErrorStream.h \
../../../interfaces/legacy/wsgi/WsgiInputStream.h \
../../../interfaces/legacy/wsgi/WsgiResponseBody.h \
diff --git a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/PVR.h b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/PVR.h
index 3d9c19ba88..c3377d1ebf 100644
--- a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/PVR.h
+++ b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/PVR.h
@@ -154,7 +154,15 @@ namespace addon
//------------------------------------------------------------------------------
//##############################################################################
-/// @defgroup cpp_kodi_addon_pvr_Defs_Menuhook 7. Menuhook
+/// @defgroup cpp_kodi_addon_pvr_Defs_Provider 7. Provider
+/// @ingroup cpp_kodi_addon_pvr_Defs
+/// @brief **Representation of a provider**\n
+/// For list of all providers from the backend.
+///
+//------------------------------------------------------------------------------
+
+//##############################################################################
+/// @defgroup cpp_kodi_addon_pvr_Defs_Menuhook 8. Menuhook
/// @ingroup cpp_kodi_addon_pvr_Defs
/// @brief **PVR Context menu data**\n
/// Define data for the context menus available to the user
@@ -162,7 +170,7 @@ namespace addon
//------------------------------------------------------------------------------
//##############################################################################
-/// @defgroup cpp_kodi_addon_pvr_Defs_EDLEntry 8. Edit decision list (EDL)
+/// @defgroup cpp_kodi_addon_pvr_Defs_EDLEntry 9. Edit decision list (EDL)
/// @ingroup cpp_kodi_addon_pvr_Defs
/// @brief **An edit decision list or EDL is used in the post-production process
/// of film editing and video editing**\n
@@ -172,7 +180,7 @@ namespace addon
//------------------------------------------------------------------------------
//##############################################################################
-/// @defgroup cpp_kodi_addon_pvr_Defs_Stream 9. Inputstream
+/// @defgroup cpp_kodi_addon_pvr_Defs_Stream 10. Inputstream
/// @ingroup cpp_kodi_addon_pvr_Defs
/// @brief **Inputstream**\n
/// This includes classes and values that are used in the PVR inputstream.
@@ -856,9 +864,9 @@ public:
//============================================================================
/// @brief Request the list of all providers from the backend.
///
- /// @param[out] results The channels defined with @ref
- /// cpp_kodi_addon_pvr_Defs_PVRProviders
- /// and available at the addon, then transferred with
+ /// @param[out] results The channels defined with
+ /// @ref cpp_kodi_addon_pvr_Defs_PVRProvider and
+ /// available at the addon, then transferred with
/// @ref cpp_kodi_addon_pvr_Defs_PVRProvidersResultSet.
/// @return @ref PVR_ERROR_NO_ERROR if the list has been fetched successfully.
///
@@ -867,12 +875,7 @@ public:
///
/// --------------------------------------------------------------------------
///
- /// @copydetails cpp_kodi_addon_pvr_Defs_PVRProviders_Help
- ///
- ///
- /// --------------------------------------------------------------------------
- ///
- ///
+ /// @copydetails cpp_kodi_addon_pvr_Defs_PVRProvider_Help
///
///---------------------------------------------------------------------------
///
diff --git a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Providers.h b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Providers.h
index ddbb1887cc..40203c5948 100644
--- a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Providers.h
+++ b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Providers.h
@@ -57,7 +57,7 @@ public:
/// | **Provider type** | @ref PVR_PROVIDER_TYPE | @ref PVRProvider::SetType "SetType" | @ref PVRProvider::GetType "GetType" | *optional*
/// | **Icon path** | `std::string` | @ref PVRProvider::SetIconPath "SetIconPath" | @ref PVRProvider::GetIconPath "GetIconPath" | *optional*
/// | **Countries** | `std::vecotr<std::string>` | @ref PVRProvider::SetCountries "SetCountries" | @ref PVRProvider::GetCountries "GetCountries" | *optional*
- /// | **Langauges** | `std::vecotr<std::string>` | @ref PVRProvider::SetLangauges "SetLangauges" | @ref PVRProvider::GetLangauges "GetLangauges" | *optional*
+ /// | **Langauges** | `std::vecotr<std::string>` | @ref PVRProvider::SetLanguages "SetLanguages" | @ref PVRProvider::GetLanguages "GetLanguages" | *optional*
///
/// @addtogroup cpp_kodi_addon_pvr_Defs_PVRProvider
@@ -83,7 +83,7 @@ public:
/// @brief **optional**\n
/// Provider type.
///
- /// Set to @ref PVR_PVR_PROVIDER_TYPE_UNKNOWN if the type cannot be
+ /// Set to @ref PVR_PROVIDER_TYPE_UNKNOWN if the type cannot be
/// determined.
///
/// --------------------------------------------------------------------------
diff --git a/xbmc/guilib/_Controls.dox b/xbmc/guilib/_Controls.dox
index 015a382e24..c9947c3479 100644
--- a/xbmc/guilib/_Controls.dox
+++ b/xbmc/guilib/_Controls.dox
@@ -7,6 +7,7 @@ manual will explain each and every control in detail.
- \subpage Addon_Rendering_control - Control where rendering becomes performed from add-on
- \subpage skin_Button_control - a standard push button control.
+- \subpage Color_button_control - used for creating push buttons in Kodi with a box for color preview.
- \subpage EPGGrid_control - used to display the EPG guide in the PVR section.
- \subpage skin_Edit_control - used as an input control for the osd keyboard and other input fields.
- \subpage Fade_Label_Control - used to show multiple pieces of text in the same position, by fading from one to the other.
@@ -26,7 +27,6 @@ manual will explain each and every control in detail.
- \subpage Radio_button_control - a radio button control (as used for on/off settings).
- \subpage Resize_Control - used to set the pixel ratio in Video Calibration.
- \subpage Scroll_Bar_Control - used for a implementing a scroll bar.
-- \subpage Select_Button_Control - Button with multi selection choice.
- \subpage Settings_Slider_Control - used for a slider control in the settings menus.
- \subpage Settings_Spin_Control - used for cycling up/down controls in the settings menus.
- \subpage Slider_Control - used for a volume slider.
diff --git a/xbmc/interfaces/legacy/Addon.h b/xbmc/interfaces/legacy/Addon.h
index 68b2261064..97c598f22c 100644
--- a/xbmc/interfaces/legacy/Addon.h
+++ b/xbmc/interfaces/legacy/Addon.h
@@ -101,10 +101,9 @@ namespace XBMCAddon
///
/// \ingroup python_xbmcaddon
/// @brief \python_func{ xbmcaddon.Addon([id]).getSettings() }
- ///-----------------------------------------------------------------------
/// Returns a wrapper around the addon's settings.
///
- /// @return `Settings` wrapper
+ /// @return @ref python_settings wrapper
///
///
///-----------------------------------------------------------------------
diff --git a/xbmc/interfaces/legacy/InfoTagGame.h b/xbmc/interfaces/legacy/InfoTagGame.h
index 18b2824496..a6161b4582 100644
--- a/xbmc/interfaces/legacy/InfoTagGame.h
+++ b/xbmc/interfaces/legacy/InfoTagGame.h
@@ -235,7 +235,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setTitle(title) }
- ///-----------------------------------------------------------------------
/// Sets the title of the game.
///
/// @param title string - title.
@@ -253,7 +252,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setPlatform(platform) }
- ///-----------------------------------------------------------------------
/// Sets the platform on which the game is run.
///
/// @param platform string - platform.
@@ -271,7 +269,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setGenres(genres) }
- ///-----------------------------------------------------------------------
/// Sets the genres of the game.
///
/// @param genres list - genres.
@@ -289,7 +286,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setPublisher(publisher) }
- ///-----------------------------------------------------------------------
/// Sets the publisher of the game.
///
/// @param publisher string - publisher.
@@ -307,7 +303,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setDeveloper(developer) }
- ///-----------------------------------------------------------------------
/// Sets the developer of the game.
///
/// @param developer string - title.
@@ -325,7 +320,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setOverview(overview) }
- ///-----------------------------------------------------------------------
/// Sets the overview of the game.
///
/// @param overview string - overview.
@@ -343,7 +337,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setYear(year) }
- ///-----------------------------------------------------------------------
/// Sets the year in which the game was published.
///
/// @param year integer - year.
@@ -361,7 +354,6 @@ public:
///
/// \ingroup python_InfoTagGame
/// @brief \python_func{ setGameClient(gameClient) }
- ///-----------------------------------------------------------------------
/// Sets the add-on ID of the game client executing the game.
///
/// @param gameClient string - game client.
diff --git a/xbmc/interfaces/legacy/InfoTagPicture.h b/xbmc/interfaces/legacy/InfoTagPicture.h
index b722c687fd..a03bf0f318 100644
--- a/xbmc/interfaces/legacy/InfoTagPicture.h
+++ b/xbmc/interfaces/legacy/InfoTagPicture.h
@@ -128,7 +128,6 @@ public:
///
/// \ingroup python_InfoTagPicture
/// @brief \python_func{ setResolution(width, height) }
- ///-----------------------------------------------------------------------
/// Sets the resolution of the picture.
///
/// @param width int - Width of the picture in pixels.
diff --git a/xbmc/interfaces/legacy/InfoTagVideo.h b/xbmc/interfaces/legacy/InfoTagVideo.h
index 68cb1b4336..f5f79d63b5 100644
--- a/xbmc/interfaces/legacy/InfoTagVideo.h
+++ b/xbmc/interfaces/legacy/InfoTagVideo.h
@@ -1613,7 +1613,6 @@ namespace XBMCAddon
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getUniqueID(key) }
- ///-----------------------------------------------------------------------
/// Get the unique ID of the given key.
/// A unique ID is an identifier used by a (online) video database used to
/// identify a video in its database.
@@ -1662,7 +1661,6 @@ namespace XBMCAddon
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setUniqueIDs(values, defaultUniqueID) }
- ///-----------------------------------------------------------------------
/// Set the given unique IDs.
/// A unique ID is an identifier used by a (online) video database used to
/// identify a video in its database.
diff --git a/xbmc/interfaces/legacy/ListItem.h b/xbmc/interfaces/legacy/ListItem.h
index 9cf8cd2bc6..72813d7cf6 100644
--- a/xbmc/interfaces/legacy/ListItem.h
+++ b/xbmc/interfaces/legacy/ListItem.h
@@ -219,7 +219,6 @@ namespace XBMCAddon
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getDateTime() }
- ///-----------------------------------------------------------------------
/// Returns the list item's datetime in W3C format (YYYY-MM-DDThh:mm:ssTZD).
///
/// @return string or unicode - datetime string (W3C).
@@ -245,7 +244,6 @@ namespace XBMCAddon
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setDateTime(dateTime) }
- ///-----------------------------------------------------------------------
/// Sets the list item's datetime in W3C format.
/// The following formats are supported:
/// - YYYY
@@ -479,7 +477,6 @@ namespace XBMCAddon
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ isFolder() }
- ///-----------------------------------------------------------------------
/// Returns whether the item is a folder or not.
///
///-----------------------------------------------------------------------
diff --git a/xbmc/interfaces/legacy/Player.h b/xbmc/interfaces/legacy/Player.h
index 6a00db73eb..f27772a290 100644
--- a/xbmc/interfaces/legacy/Player.h
+++ b/xbmc/interfaces/legacy/Player.h
@@ -462,7 +462,6 @@ namespace XBMCAddon
///
/// \ingroup python_Player
/// @brief \python_func{ getPlayingItem() }
- ///-----------------------------------------------------------------------
/// Returns the current playing item.
///
/// @return Playing item
diff --git a/xbmc/interfaces/legacy/Settings.h b/xbmc/interfaces/legacy/Settings.h
index 945ce0ae16..e4a583a269 100644
--- a/xbmc/interfaces/legacy/Settings.h
+++ b/xbmc/interfaces/legacy/Settings.h
@@ -30,7 +30,7 @@ XBMCCOMMONS_STANDARD_EXCEPTION(SettingCallbacksNotSupportedException);
//
/// \defgroup python_settings Settings
-/// \ingroup python_settings
+/// \ingroup python_xbmcaddon
/// @{
/// @brief **Add-on settings**
///
@@ -48,6 +48,7 @@ XBMCCOMMONS_STANDARD_EXCEPTION(SettingCallbacksNotSupportedException);
/// settings = xbmc.Addon('id').getSettings()
/// ...
/// ~~~~~~~~~~~~~
+//
class Settings : public AddonClass
{
public:
@@ -65,7 +66,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getBool(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a boolean.
///
/// @param id string - id of the setting that the module needs to access.
@@ -91,7 +91,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getInt(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as an integer.
///
/// @param id string - id of the setting that the module needs to access.
@@ -117,7 +116,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getNumber(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a floating point number.
///
/// @param id string - id of the setting that the module needs to access.
@@ -143,7 +141,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getString(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a unicode string.
///
/// @param id string - id of the setting that the module needs to access.
@@ -169,7 +166,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getBoolList(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a list of booleans.
///
/// @param id string - id of the setting that the module needs to access.
@@ -195,7 +191,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getIntList(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a list of integers.
///
/// @param id string - id of the setting that the module needs to access.
@@ -221,7 +216,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getNumberList(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a list of floating point numbers.
///
/// @param id string - id of the setting that the module needs to access.
@@ -247,7 +241,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ getStringList(id) }
- ///-----------------------------------------------------------------------
/// Returns the value of a setting as a list of unicode strings.
///
/// @param id string - id of the setting that the module needs to access.
@@ -273,7 +266,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setBool(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -303,7 +295,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setInt(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -333,7 +324,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setNumber(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -363,7 +353,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setString(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -393,7 +382,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setBoolList(id, values) }
- ///-----------------------------------------------------------------------
/// Sets the boolean values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -423,7 +411,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setIntList(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the integer values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -453,7 +440,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setNumberList(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the floating point values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -483,7 +469,6 @@ public:
///
/// \ingroup python_settings
/// @brief \python_func{ setStringList(id, value) }
- ///-----------------------------------------------------------------------
/// Sets the string values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
@@ -509,6 +494,7 @@ public:
void setStringList(const char* id, const std::vector<String>& values);
#endif
};
+//@}
} // namespace xbmcaddon
} // namespace XBMCAddon
generated by cgit v1.2.3 (git 2.26.2) at 2024-11-29 01:47:03 +0000