diff options
author | Alwin Esch <alwin.esch@web.de> | 2021-11-12 20:40:34 +0100 |
---|---|---|
committer | Alwin Esch <alwin.esch@web.de> | 2021-12-29 22:53:45 +0100 |
commit | 0cff2bd138606f9d0488e04ee14062654d8fe1e3 (patch) | |
tree | 3bfafcefbfb8e11109fd0894ae034803e3370df4 | |
parent | 9567be89b2b150e50a1c846c2192f15a44712102 (diff) |
[addons][imagedecoder] minor addon.xml doc change
This corrects the documentation about addon.xml for imagedecoder addons and to add new used ways to declare supported mimetype and extension.
-rw-r--r-- | xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/ImageDecoder.h | 46 |
1 files changed, 31 insertions, 15 deletions
diff --git a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/ImageDecoder.h b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/ImageDecoder.h index 6745699ccf..eb98f90028 100644 --- a/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/ImageDecoder.h +++ b/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/ImageDecoder.h @@ -383,9 +383,20 @@ private: /// <requires>@ADDON_DEPENDS@</requires> /// <extension /// point="kodi.imagedecoder" -/// extension=".imga|.imgb" -/// mimetype="image/mymimea|image/mymimea" -/// library_@PLATFORM@="@LIBRARY_FILENAME@"/> +/// library_@PLATFORM@="@LIBRARY_FILENAME@"> +/// <support> +/// <mimetype name="image/mymimea"> +/// <extension>.imga</extension> +/// <description>30100</description> +/// <icon>resources/file_format_icon_a.png</icon> +/// </mimetype> +/// <mimetype name="image/mymimeb"> +/// <extension>.imgb</extension> +/// <description>30101</description> +/// <icon>resources/file_format_icon_b.png</icon> +/// </mimetype> +/// </support> +/// </extension> /// <extension point="xbmc.addon.metadata"> /// <summary lang="en_GB">My image decoder addon summary</summary> /// <description lang="en_GB">My image decoder description</description> @@ -406,24 +417,29 @@ private: /// string, /// The identification of the addon instance to image decoder is mandatory /// <b>`kodi.imagedecoder`</b>. In addition\, the instance declared in the -/// first <b>`<extension ... />`</b> is also the main type of addon. +/// first <b>`<support>`</b> is also the main type of addon. /// } -/// \table_row3{ <b>`extension`</b>, -/// @anchor cpp_kodi_addon_imagedecoder_defaultPort +/// \table_row3{ <b>`library_@PLATFORM@`</b>, +/// @anchor cpp_kodi_addon_imagedecoder_library /// string, -/// The from addon operated and supported image file endings.\n -/// Use a <b>`|`</b> to separate between different ones. +/// The runtime library used for the addon. This is usually declared by `cmake` and correctly displayed in the translated <b>`addon.xml`</b>. /// } -/// \table_row3{ <b>`defaultPort`</b>, -/// @anchor cpp_kodi_addon_imagedecoder_defaultPort -/// string, +/// \table_row3{ <b>`<support>...</support>`</b>, +/// @anchor cpp_kodi_addon_imagedecoder_support +/// XML group, +/// Contains the formats supported by the addon. +/// } +/// \table_row3{ <b>`<mimetype name="image/mymimea">...</mimetype>`</b>, +/// @anchor cpp_kodi_addon_imagedecoder_mimetype +/// string / group, /// The from addon operated image [mimetypes](https://en.wikipedia.org/wiki/Media_type).\n -/// Use a <b>`|`</b> to separate between different ones. +/// Optional can be with `<description>` and `<icon>` additional info added where used for list views in Kodi. /// } -/// \table_row3{ <b>`library_@PLATFORM@`</b>, -/// @anchor cpp_kodi_addon_imagedecoder_library +/// \table_row3{ <b>`<mimetype ...><extension>...</extension></mimetype>`</b>, +/// @anchor cpp_kodi_addon_imagedecoder_mimetype /// string, -/// The runtime library used for the addon. This is usually declared by `cmake` and correctly displayed in the translated <b>`addon.xml`</b>. +/// The file extensions / styles supported by this addon and relates to given mimetype before.\n +/// @note Required to use about info support by @ref CInstanceImageDecoder::SupportsFile and @ref CInstanceImageDecoder::ReadTag! /// } /// \table_end /// |