From b9413d3ff50c662d0da26519cbe7a4a4391bf34b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 24 Aug 2020 12:27:18 +0200 Subject: [PATCH] doc: avoid plugin interface strings getting out of sync with docs. --- src/Magnum/Audio/AbstractImporter.cpp | 6 +++++- src/Magnum/Audio/AbstractImporter.h | 4 +--- src/Magnum/Text/AbstractFont.cpp | 6 +++++- src/Magnum/Text/AbstractFont.h | 4 +--- src/Magnum/Text/AbstractFontConverter.cpp | 6 +++++- src/Magnum/Text/AbstractFontConverter.h | 4 +--- src/Magnum/Trade/AbstractImageConverter.cpp | 6 +++++- src/Magnum/Trade/AbstractImageConverter.h | 4 +--- src/Magnum/Trade/AbstractImporter.cpp | 6 +++++- src/Magnum/Trade/AbstractImporter.h | 4 +--- src/Magnum/Trade/AbstractSceneConverter.cpp | 6 +++++- src/Magnum/Trade/AbstractSceneConverter.h | 4 +--- 12 files changed, 36 insertions(+), 24 deletions(-) diff --git a/src/Magnum/Audio/AbstractImporter.cpp b/src/Magnum/Audio/AbstractImporter.cpp index fd8fe5c8f..8dd0b25c3 100644 --- a/src/Magnum/Audio/AbstractImporter.cpp +++ b/src/Magnum/Audio/AbstractImporter.cpp @@ -38,7 +38,11 @@ namespace Magnum { namespace Audio { std::string AbstractImporter::pluginInterface() { - return "cz.mosra.magnum.Audio.AbstractImporter/0.1"; + return +/* [interface] */ +"cz.mosra.magnum.Audio.AbstractImporter/0.1" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Audio/AbstractImporter.h b/src/Magnum/Audio/AbstractImporter.h index 328456c1d..7facf51bd 100644 --- a/src/Magnum/Audio/AbstractImporter.h +++ b/src/Magnum/Audio/AbstractImporter.h @@ -123,9 +123,7 @@ class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractManagi /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Audio.AbstractImporter/0.1" - * @endcode + * @snippet Magnum/Audio/AbstractImporter.cpp interface */ static std::string pluginInterface(); diff --git a/src/Magnum/Text/AbstractFont.cpp b/src/Magnum/Text/AbstractFont.cpp index 71916542b..e8492642f 100644 --- a/src/Magnum/Text/AbstractFont.cpp +++ b/src/Magnum/Text/AbstractFont.cpp @@ -43,7 +43,11 @@ namespace Magnum { namespace Text { std::string AbstractFont::pluginInterface() { - return "cz.mosra.magnum.Text.AbstractFont/0.3"; + return +/* [interface] */ +"cz.mosra.magnum.Text.AbstractFont/0.3" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Text/AbstractFont.h b/src/Magnum/Text/AbstractFont.h index cd3bff9a8..cfc3701b6 100644 --- a/src/Magnum/Text/AbstractFont.h +++ b/src/Magnum/Text/AbstractFont.h @@ -184,9 +184,7 @@ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin { /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Text.AbstractFont/0.3" - * @endcode + * @snippet Magnum/Text/AbstractFont.cpp interface */ static std::string pluginInterface(); diff --git a/src/Magnum/Text/AbstractFontConverter.cpp b/src/Magnum/Text/AbstractFontConverter.cpp index d647dc2dd..ff7bc364c 100644 --- a/src/Magnum/Text/AbstractFontConverter.cpp +++ b/src/Magnum/Text/AbstractFontConverter.cpp @@ -58,7 +58,11 @@ std::u32string uniqueUnicode(const std::string& characters) } std::string AbstractFontConverter::pluginInterface() { - return "cz.mosra.magnum.Text.AbstractFontConverter/0.2"; + return +/* [interface] */ +"cz.mosra.magnum.Text.AbstractFontConverter/0.2" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Text/AbstractFontConverter.h b/src/Magnum/Text/AbstractFontConverter.h index 29ab68e73..86cce4cc4 100644 --- a/src/Magnum/Text/AbstractFontConverter.h +++ b/src/Magnum/Text/AbstractFontConverter.h @@ -168,9 +168,7 @@ class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPl /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Text.AbstractFontConverter/0.2" - * @endcode + * @snippet Magnum/Text/AbstractFontConverter.cpp interface */ static std::string pluginInterface(); diff --git a/src/Magnum/Trade/AbstractImageConverter.cpp b/src/Magnum/Trade/AbstractImageConverter.cpp index 2f76e5604..20be105e7 100644 --- a/src/Magnum/Trade/AbstractImageConverter.cpp +++ b/src/Magnum/Trade/AbstractImageConverter.cpp @@ -43,7 +43,11 @@ namespace Magnum { namespace Trade { std::string AbstractImageConverter::pluginInterface() { - return "cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1"; + return +/* [interface] */ +"cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index 5dd4ad006..9f33d6b92 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -206,9 +206,7 @@ class MAGNUM_TRADE_EXPORT AbstractImageConverter: public PluginManager::Abstract /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1" - * @endcode + * @snippet Magnum/Trade/AbstractImageConverter.cpp interface */ static std::string pluginInterface(); diff --git a/src/Magnum/Trade/AbstractImporter.cpp b/src/Magnum/Trade/AbstractImporter.cpp index 0fda5dbd8..2fc827b43 100644 --- a/src/Magnum/Trade/AbstractImporter.cpp +++ b/src/Magnum/Trade/AbstractImporter.cpp @@ -59,7 +59,11 @@ namespace Magnum { namespace Trade { std::string AbstractImporter::pluginInterface() { - return "cz.mosra.magnum.Trade.AbstractImporter/0.3.2"; + return +/* [interface] */ +"cz.mosra.magnum.Trade.AbstractImporter/0.3.2" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index 5e9541484..435c35653 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -336,9 +336,7 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Trade.AbstractImporter/0.3.2" - * @endcode + * @snippet Magnum/Trade/AbstractImporter.cpp interface */ static std::string pluginInterface(); diff --git a/src/Magnum/Trade/AbstractSceneConverter.cpp b/src/Magnum/Trade/AbstractSceneConverter.cpp index 05a2246de..ae2c7ddf0 100644 --- a/src/Magnum/Trade/AbstractSceneConverter.cpp +++ b/src/Magnum/Trade/AbstractSceneConverter.cpp @@ -41,7 +41,11 @@ namespace Magnum { namespace Trade { std::string AbstractSceneConverter::pluginInterface() { - return "cz.mosra.magnum.Trade.AbstractSceneConverter/0.1"; + return +/* [interface] */ +"cz.mosra.magnum.Trade.AbstractSceneConverter/0.1" +/* [interface] */ + ; } #ifndef CORRADE_PLUGINMANAGER_NO_DYNAMIC_PLUGIN_SUPPORT diff --git a/src/Magnum/Trade/AbstractSceneConverter.h b/src/Magnum/Trade/AbstractSceneConverter.h index 4763a43d8..2195db3aa 100644 --- a/src/Magnum/Trade/AbstractSceneConverter.h +++ b/src/Magnum/Trade/AbstractSceneConverter.h @@ -180,9 +180,7 @@ class MAGNUM_TRADE_EXPORT AbstractSceneConverter: public PluginManager::Abstract /** * @brief Plugin interface * - * @code{.cpp} - * "cz.mosra.magnum.Trade.AbstractSceneConverter/0.1" - * @endcode + * @snippet Magnum/Trade/AbstractSceneConverter.cpp interface */ static std::string pluginInterface();