Browse Source

doc: reference CLI utils from plugin interface classes.

pull/481/head
Vladimír Vondruš 6 years ago
parent
commit
5c223d2045
  1. 5
      src/Magnum/ShaderTools/AbstractConverter.h
  2. 6
      src/Magnum/Text/AbstractFontConverter.h
  3. 7
      src/Magnum/Trade/AbstractImageConverter.h
  4. 7
      src/Magnum/Trade/AbstractImporter.h
  5. 7
      src/Magnum/Trade/AbstractSceneConverter.h

5
src/Magnum/ShaderTools/AbstractConverter.h

@ -316,6 +316,11 @@ different representations or performing optimizations and other operations on
them. See @ref plugins for more information and `*ShaderConverter` classes in
the @ref ShaderTools namespace for available scene converter plugins.
@m_class{m-note m-success}
@par
There's also a @ref magnum-shaderconverter "magnum-shaderconverter" tool, exposing functionality of all shader converter plugins on a command line.
@section ShaderTools-AbstractConverter-usage Usage
Shader converters are most commonly implemented as plugins. Depending on

6
src/Magnum/Text/AbstractFontConverter.h

@ -125,6 +125,12 @@ namespace for available font converter plugins.
You can use the @ref magnum-fontconverter "magnum-fontconverter" utility to do
font conversion on command-line.
@m_class{m-note m-success}
@par
There's also a @ref magnum-fontconverter "magnum-fontconverter" tool,
exposing functionality of all font converter plugins on a command line.
@section Text-AbstractFontConverter-subclassing Subclassing
Plugin implements @ref doFeatures() and one or more of `exportTo*()` /

7
src/Magnum/Trade/AbstractImageConverter.h

@ -145,6 +145,13 @@ Provides functionality for converting images between various internal formats
or compressing them. See @ref plugins for more information and `*ImageConverter`
classes in @ref Trade namespace for available image converter plugins.
@m_class{m-note m-success}
@par
There's also a @ref magnum-imageconverter "magnum-imageconverter" tool,
exposing functionality of all image converter plugins on a command line as
well as performing introspection of image files.
@section Trade-AbstractImageConverter-data-dependency Data dependency
The instances returned from various functions *by design* have no dependency on

7
src/Magnum/Trade/AbstractImporter.h

@ -158,6 +158,13 @@ like this, completely with all error handling:
See @ref plugins for more information about general plugin usage and
`*Importer` classes in the @ref Trade namespace for available importer plugins.
@m_class{m-note m-success}
@par
There are also @ref magnum-imageconverter "magnum-imageconverter" and
@ref magnum-sceneconverter "magnum-sceneconverter" tools which you can use
to perform introspection of image and scene files.
@subsection Trade-AbstractImporter-usage-callbacks Loading data from memory, using file callbacks
Besides loading data directly from the filesystem using @ref openFile() like

7
src/Magnum/Trade/AbstractSceneConverter.h

@ -135,6 +135,13 @@ various formats or performing optimizations and other operations on them. See
@ref plugins for more information and `*SceneConverter` classes in the
@ref Trade namespace for available scene converter plugins.
@m_class{m-note m-success}
@par
There's also a @ref magnum-sceneconverter "magnum-sceneconverter" tool,
exposing functionality of all scene converter plugins on a command line as
well as performing introspection of scene files.
@section Trade-AbstractSceneConverter-data-dependency Data dependency
The instances returned from various functions *by design* have no dependency on

Loading…
Cancel
Save