From 2af16e9360ffa5223b68c6a2e1f7475628e32701 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 12 Jan 2018 14:42:04 +0100 Subject: [PATCH] doc: building documentation updates etc. --- src/MagnumPlugins/AnyAudioImporter/AnyImporter.h | 12 +++++++----- .../AnyImageConverter/AnyImageConverter.h | 12 +++++++----- .../AnyImageImporter/AnyImageImporter.h | 12 +++++++----- .../AnySceneImporter/AnySceneImporter.h | 12 +++++++----- 4 files changed, 28 insertions(+), 20 deletions(-) diff --git a/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h b/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h index 179e3b1c1..4c0eb8f67 100644 --- a/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h +++ b/src/MagnumPlugins/AnyAudioImporter/AnyImporter.h @@ -58,11 +58,13 @@ namespace Magnum { namespace Audio { Detects file type based on file extension, loads corresponding plugin and then tries to open the file with it. -This plugin is built if `WITH_ANYAUDIOIMPORTER` is enabled when building -Magnum Plugins. To use dynamic plugin, you need to load `AnyAudioImporter` -plugin from `MAGNUM_PLUGINS_IMPORTER_DIR`. To use static plugin, you need to -request `AnyAudioImporter` component of `MagnumPlugins` package in CMake and -link to `MagnumPlugins::AnyAudioImporter` target. See @ref building-plugins, +This plugin depends on the @ref Audio library and is built if +`WITH_ANYAUDIOIMPORTER` is enabled when building Magnum Plugins. To use as a +dynamic plugin, you need to load the @cpp "AnyAudioImporter" @ce plugin from +`MAGNUM_PLUGINS_IMPORTER_DIR`. To use as a static plugin or as a dependency of +another plugin with CMake, you need to request the `AnyAudioImporter` component +of the `MagnumPlugins` package and link to the +`MagnumPlugins::AnyAudioImporter` target. See @ref building-plugins, @ref cmake-plugins and @ref plugins for more information. Supported formats: diff --git a/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h b/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h index 2cca7e1be..fc3fb15c0 100644 --- a/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h +++ b/src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h @@ -57,11 +57,13 @@ namespace Magnum { namespace Trade { Detects file type based on file extension, loads corresponding plugin and then tries to convert the file with it. -This plugin is built if `WITH_ANYIMAGECONVERTER` is enabled when building -Magnum Plugins. To use dynamic plugin, you need to load `AnyImageConverter` -plugin from `MAGNUM_PLUGINS_IMPORTER_DIR`. To use static plugin, you need to -request `AnyImageConverter` component of `MagnumPlugins` package in CMake and -link to `MagnumPlugins::AnyImageConverter` target. See @ref building-plugins, +This plugin depends on the @ref Trade library and is built if +`WITH_ANYIMAGECONVERTER` is enabled when building Magnum Plugins. To use as a +dynamic plugin, you need to load the @cpp "AnyImageConverter" @ce plugin from +`MAGNUM_PLUGINS_IMPORTER_DIR`. To use as a static plugin or as a dependency of +another plugin with CMake, you need to request the `AnyImageConverter` +component of the `MagnumPlugins` package and link to the +`MagnumPlugins::AnyImageConverter` target. See @ref building-plugins, @ref cmake-plugins and @ref plugins for more information. Supported formats for uncompressed data: diff --git a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h index 5f8037d11..bcaca9c39 100644 --- a/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h +++ b/src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h @@ -57,11 +57,13 @@ namespace Magnum { namespace Trade { Detects file type based on file extension, loads corresponding plugin and then 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` target. See @ref building-plugins, +This plugin depends on the @ref Trade library and is built if +`WITH_ANYIMAGEIMPORTER` is enabled when building Magnum Plugins. To use as a +dynamic plugin, you need to load the @cpp "AnyImageImporter" @ce plugin from +`MAGNUM_PLUGINS_IMPORTER_DIR`. To use as a static plugin or as a dependency of +another plugin with CMake, you need to request the `AnyImageImporter` component +of the `MagnumPlugins` package and link to the +`MagnumPlugins::AnyImageImporter` target. See @ref building-plugins, @ref cmake-plugins and @ref plugins for more information. Supported formats: diff --git a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h index 8c69d440b..03071e385 100644 --- a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h +++ b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h @@ -57,11 +57,13 @@ namespace Magnum { namespace Trade { Detects file type based on file extension, loads corresponding plugin and then 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` target. See @ref building-plugins, +This plugin depends on the @ref Trade library and is built if +`WITH_ANYSCENEIMPORTER` is enabled when building Magnum Plugins. To use as a +dynamic plugin, you need to load the @cpp "AnySceneImporter" @ce plugin from +`MAGNUM_PLUGINS_IMPORTER_DIR`. To use as a static plugin or as a dependency of +another plugin with CMake, you need to request the `AnySceneImporter` component +of the `MagnumPlugins` package in CMake and link to the +`MagnumPlugins::AnySceneImporter` target. See @ref building-plugins, @ref cmake-plugins and @ref plugins for more information. Supported formats: