Browse Source

doc: building documentation updates etc.

pull/205/head
Vladimír Vondruš 8 years ago
parent
commit
2af16e9360
  1. 12
      src/MagnumPlugins/AnyAudioImporter/AnyImporter.h
  2. 12
      src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h
  3. 12
      src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h
  4. 12
      src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h

12
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:

12
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:

12
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:

12
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:

Loading…
Cancel
Save