From 0d9c21b4913d1746a90309f2550ca52edd98b6cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 27 Jul 2014 12:09:36 +0200 Subject: [PATCH] doc: mention plugin interface string in plugin interface docs. --- src/Magnum/Audio/AbstractImporter.h | 2 ++ src/Magnum/Text/AbstractFont.h | 2 ++ src/Magnum/Text/AbstractFontConverter.h | 2 ++ src/Magnum/Trade/AbstractImageConverter.h | 2 ++ src/Magnum/Trade/AbstractImporter.h | 4 +++- 5 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/Magnum/Audio/AbstractImporter.h b/src/Magnum/Audio/AbstractImporter.h index 429253d11..86d60d918 100644 --- a/src/Magnum/Audio/AbstractImporter.h +++ b/src/Magnum/Audio/AbstractImporter.h @@ -59,6 +59,8 @@ checked by the implementation: supported. - All `do*()` implementations working on opened file are called only if there is any file opened. + +Plugin interface string is `"cz.mosra.magnum.Audio.AbstractImporter/0.1"`. */ class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Audio.AbstractImporter/0.1") diff --git a/src/Magnum/Text/AbstractFont.h b/src/Magnum/Text/AbstractFont.h index e903cef6f..54d088377 100644 --- a/src/Magnum/Text/AbstractFont.h +++ b/src/Magnum/Text/AbstractFont.h @@ -71,6 +71,8 @@ checked by the implementation: @ref Feature::OpenData is supported. - All `do*()` implementations working on opened file are called only if there is any file opened. + +Plugin interface string is `"cz.mosra.magnum.Text.AbstractFont/0.2.3"`. */ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Text.AbstractFont/0.2.3") diff --git a/src/Magnum/Text/AbstractFontConverter.h b/src/Magnum/Text/AbstractFontConverter.h index 015ce5038..c2af1025a 100644 --- a/src/Magnum/Text/AbstractFontConverter.h +++ b/src/Magnum/Text/AbstractFontConverter.h @@ -67,6 +67,8 @@ checked by the implementation: if @ref Feature::ConvertData is supported. - Function `doImport*FromData()` is called only if there is at least one data array passed. + +Plugin interface string is `"cz.mosra.magnum.Text.AbstractFontConverter/0.1.1"`. */ class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Text.AbstractFontConverter/0.1.1") diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index 4c39a6144..c2994d39b 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -55,6 +55,8 @@ checked by the implementation: - Functions @ref doExportToImage() or @ref doExportToData() are called only if @ref Feature::ConvertImage or @ref Feature::ConvertData is supported. + +Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1"`. */ class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1") diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index 10023b4b9..00dfff541 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -72,6 +72,8 @@ checked by the implementation: - All `do*()` implementations taking data ID as parameter are called only if the ID is from valid range. +Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImporter/0.3"`. + @todo How to handle casting from std::unique_ptr<> in more convenient way? */ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlugin { @@ -94,7 +96,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug /** @brief Default constructor */ explicit AbstractImporter(); - /** @brief Default constructor with access to plugin manager */ + /** @brief Constructor with access to plugin manager */ explicit AbstractImporter(PluginManager::Manager& manager); /** @brief Plugin manager constructor */