From 7da85e659d7fef8c676c9f87fc54f0165b23c0a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 7 Sep 2015 22:22:20 +0200 Subject: [PATCH] Any*Importer: proper docs. Not sure why this was omitted. --- .../AnyImageImporter/AnyImageImporter.h | 14 +++++++++++++- .../AnySceneImporter/AnySceneImporter.h | 14 +++++++++++++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h index 96690e807..a8f709bd5 100644 --- a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h +++ b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h @@ -52,7 +52,19 @@ namespace Magnum { namespace Trade { @brief Any image importer plugin Detects file type based on file extension, loads corresponding plugin and then -tries to open the file with it. Supported formats: +tries to open the file with it. + +This plugin is built if `WITH_ANYIMAGEIMPORTER` is enabled when building +Magnum Plugins. To use dynamic plugin, you need to load `AnyImageImporter` +plugin from `MAGNUM_PLUGINS_IMPORTER_DIR`. To use static plugin, you need to +request `AnyImageImporter` component of `MagnumPlugins` package in CMake and +link to `${MAGNUMPLUGINS_ANYIMAGEIMPORTER_LIBRARIES}`. To use this as a +dependency of another plugin, you additionally need to add +`${MAGNUMPLUGINS_ANYIMAGEIMPORTER_INCLUDE_DIRS}` to include path. See +@ref building-plugins, @ref cmake-plugins and @ref plugins for more +information. + +Supported formats: - BMP (`*.bmp`), loaded with any plugin that provides `BmpImporter` - DDS (`*.dds`), loaded with @ref DdsImporter or any other plugin that diff --git a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h index 9574e1d4c..c11c2c2fe 100644 --- a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h +++ b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h @@ -37,7 +37,19 @@ namespace Magnum { namespace Trade { @brief Any scene importer plugin Detects file type based on file extension, loads corresponding plugin and then -tries to open the file with it. Supported formats: +tries to open the file with it. + +This plugin is built if `WITH_ANYSCENEIMPORTER` is enabled when building +Magnum Plugins. To use dynamic plugin, you need to load `AnySceneImporter` +plugin from `MAGNUM_PLUGINS_IMPORTER_DIR`. To use static plugin, you need to +request `AnySceneImporter` component of `MagnumPlugins` package in CMake and +link to `${MAGNUMPLUGINS_ANYSCENEIMPORTER_LIBRARIES}`. To use this as a +dependency of another plugin, you additionally need to add +`${MAGNUMPLUGINS_ANYSCENEIMPORTER_INCLUDE_DIRS}` to include path. See +@ref building-plugins, @ref cmake-plugins and @ref plugins for more +information. + +Supported formats: - COLLADA (`*.dae`), loaded with @ref ColladaImporter or any other plugin that provides it