From d310e2f04c8dec3069622671d0fed908e02bf60a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 9 Apr 2023 19:30:23 +0200 Subject: [PATCH] Visibly link to the base interface docs from all plugin classes. So people new to the plugin stuff can quickly get to usage introduction and code snippets. The plugins alone don't list anything like that and it may be *very* confusing otherwise. --- src/MagnumPlugins/AnyAudioImporter/AnyImporter.h | 7 +++++++ src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h | 7 +++++++ src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h | 7 +++++++ src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h | 7 +++++++ src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h | 7 +++++++ src/MagnumPlugins/AnyShaderConverter/AnyConverter.h | 7 +++++++ src/MagnumPlugins/MagnumFont/MagnumFont.h | 7 +++++++ .../MagnumFontConverter/MagnumFontConverter.h | 7 +++++++ src/MagnumPlugins/ObjImporter/ObjImporter.h | 7 +++++++ src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h | 7 +++++++ src/MagnumPlugins/TgaImporter/TgaImporter.h | 7 +++++++ src/MagnumPlugins/WavAudioImporter/WavImporter.h | 7 +++++++ 12 files changed, 84 insertions(+) diff --git a/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h b/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h index b6b2f95d1..d811d97e0 100644 --- a/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h +++ b/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h @@ -72,6 +72,13 @@ Only loading from files is supported. @section Audio-AnyImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Audio library and is built if `MAGNUM_WITH_ANYAUDIOIMPORTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnyAudioImporter" @ce via diff --git a/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h b/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h index 67af0c79b..e648758d7 100644 --- a/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h +++ b/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h @@ -84,6 +84,13 @@ is supported. @section Trade-AnyImageConverter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + via the base @ref AbstractImageConverter interface. See its documentation + for introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_ANYIMAGECONVERTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnyImageConverter" @ce via diff --git a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h index 4d5f67cbe..2e6978cc5 100644 --- a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h +++ b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h @@ -111,6 +111,13 @@ formats that are marked as such in the list above. @section Trade-AnyImageImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_ANYIMAGEIMPORTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnyImageImporter" @ce via diff --git a/src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h b/src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h index f3fed03c4..8e6e0922c 100644 --- a/src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h +++ b/src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h @@ -69,6 +69,13 @@ Only converting to files is supported. @section Trade-AnySceneConverter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractSceneConverter interface. See its + documentation for introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_ANYSCENECONVERTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnySceneConverter" @ce via diff --git a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h index 0a905fd16..64039e22e 100644 --- a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h +++ b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h @@ -102,6 +102,13 @@ format, however @ref ImporterFeature::FileCallback is supported as well. @section Trade-AnySceneImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_ANYSCENEIMPORTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnySceneImporter" @ce via diff --git a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h index ea0ca3058..c68aa4fc4 100644 --- a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h +++ b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h @@ -94,6 +94,13 @@ explicitly set. @section ShaderTools-AnyConverter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractConverter interface. See its documentation + for introduction and usage examples. + This plugin depends on the @ref ShaderTools library and is built if `MAGNUM_WITH_ANYSHADERCONVERTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "AnyShaderConverter" @ce via diff --git a/src/MagnumPlugins/MagnumFont/MagnumFont.h b/src/MagnumPlugins/MagnumFont/MagnumFont.h index 31fad4cae..1b28bbfec 100644 --- a/src/MagnumPlugins/MagnumFont/MagnumFont.h +++ b/src/MagnumPlugins/MagnumFont/MagnumFont.h @@ -118,6 +118,13 @@ rectangle=45 0 44 25 @section Text-MagnumFont-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractFont interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Text library and the @ref Trade::TgaImporter "TgaImporter" plugin. It is built if `MAGNUM_WITH_MAGNUMFONT` is enabled when building Magnum. To use as a dynamic diff --git a/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.h b/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.h index cee880b0c..5c2a49738 100644 --- a/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.h +++ b/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.h @@ -60,6 +60,13 @@ passed @ref AbstractGlyphCache to support @ref GlyphCacheFeature::ImageDownload. @section Text-MagnumFontConverter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractFontConverter interface. See its + documentation for introduction and usage examples. + This plugin depends on the @ref Text library and the @ref Trade::TgaImageConverter "TgaImageConverter" plugin. It is built if `MAGNUM_WITH_MAGNUMFONTCONVERTER` is enabled when building Magnum. To use as a diff --git a/src/MagnumPlugins/ObjImporter/ObjImporter.h b/src/MagnumPlugins/ObjImporter/ObjImporter.h index 3ca469f2a..b4938f90c 100644 --- a/src/MagnumPlugins/ObjImporter/ObjImporter.h +++ b/src/MagnumPlugins/ObjImporter/ObjImporter.h @@ -62,6 +62,13 @@ Loads Wavefront OBJ (`*.obj`) files, with the following supported features: @section Trade-ObjImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_OBJIMPORTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "ObjImporter" @ce via @ref Corrade::PluginManager::Manager. diff --git a/src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h b/src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h index a483f253b..3c3391cf9 100644 --- a/src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h +++ b/src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h @@ -60,6 +60,13 @@ Creates Truevision TGA (`*.tga`) files from images with format @section Trade-TgaImageConverter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + via the base @ref AbstractImageConverter interface. See its documentation + for introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_TGAIMAGECONVERTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "TgaImageConverter" @ce via diff --git a/src/MagnumPlugins/TgaImporter/TgaImporter.h b/src/MagnumPlugins/TgaImporter/TgaImporter.h index 9ec01052b..1c6fad99b 100644 --- a/src/MagnumPlugins/TgaImporter/TgaImporter.h +++ b/src/MagnumPlugins/TgaImporter/TgaImporter.h @@ -62,6 +62,13 @@ grayscale images with 8 bits per channel. @section Trade-TgaImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin depends on the @ref Trade library and is built if `MAGNUM_WITH_TGAIMPORTER` is enabled when building Magnum. To use as a dynamic plugin, load @cpp "TgaImporter" @ce via @ref Corrade::PluginManager::Manager. diff --git a/src/MagnumPlugins/WavAudioImporter/WavImporter.h b/src/MagnumPlugins/WavAudioImporter/WavImporter.h index 1facd0fde..eedd89ee0 100644 --- a/src/MagnumPlugins/WavAudioImporter/WavImporter.h +++ b/src/MagnumPlugins/WavAudioImporter/WavImporter.h @@ -78,6 +78,13 @@ a `RIFX` header) are supported, data is converted to machine endian on import. @section Audio-WavImporter-usage Usage +@m_class{m-note m-success} + +@par + This class is a plugin that's meant to be dynamically loaded and used + through the base @ref AbstractImporter interface. See its documentation for + introduction and usage examples. + This plugin is built if `MAGNUM_WITH_WAVAUDIOIMPORTER` is enabled when building Magnum. To use dynamic plugin, load @cpp "WavAudioImporter" @ce via @ref Corrade::PluginManager::Manager.