Trade: doc++

mosra · Mar 5, 2021 · e3c72b3 · e3c72b3
1 parent 41dc0df
commit e3c72b3
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h
@@ -110,6 +110,9 @@ enum class ImageConverterFlag: UnsignedByte {
      * Print verbose diagnostic during conversion. By default the converter
      * only prints messages on error or when some operation might cause
      * unexpected data modification or loss.
+     *
+     * Corresponds to the `-v` / `--verbose` option in
+     * @ref magnum-imageconverter "magnum-imageconverter".
      */
     Verbose = 1 << 0
 
@@ -260,6 +263,9 @@ class MAGNUM_TRADE_EXPORT AbstractImageConverter: public PluginManager::Abstract
          * Some flags can be set only if the converter supports particular
          * features, see documentation of each @ref ImageConverterFlag for more
          * information. By default no flags are set.
+         *
+         * Corresponds to the `-v` / `--verbose` option in
+         * @ref magnum-imageconverter "magnum-imageconverter".
          */
         void setFlags(ImageConverterFlags flags);
 

diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h
@@ -101,6 +101,11 @@ enum class ImporterFlag: UnsignedByte {
      * Print verbose diagnostic during import. By default the importer only
      * prints messages on error or when some operation might cause unexpected
      * data modification or loss.
+     *
+     * Corresponds to the `-v` / `--verbose` option in
+     * @ref magnum-imageconverter "magnum-imageconverter",
+     * @ref magnum-sceneconverter "magnum-sceneconverter" and
+     * @ref magnum-player "magnum-player".
      */
     Verbose = 1 << 0,
 
@@ -393,6 +398,11 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
          * opened. Some flags can be set only if the importer supports
          * particular features, see documentation of each @ref ImporterFlag for
          * more information. By default no flags are set.
+         *
+         * Corresponds to the `-v` / `--verbose` option in
+         * @ref magnum-imageconverter "magnum-imageconverter",
+         * @ref magnum-sceneconverter "magnum-sceneconverter" and
+         * @ref magnum-player "magnum-player".
          */
         void setFlags(ImporterFlags flags);
 

diff --git a/src/Magnum/Trade/AbstractSceneConverter.h b/src/Magnum/Trade/AbstractSceneConverter.h
@@ -98,6 +98,9 @@ enum class SceneConverterFlag: UnsignedByte {
      * Print verbose diagnostic during conversion. By default the converter
      * only prints messages on error or when some operation might cause
      * unexpected data modification or loss.
+     *
+     * Corresponds to the `-v` / `--verbose` option in
+     * @ref magnum-sceneconverter "magnum-sceneconverter".
      */
     Verbose = 1 << 0
 
@@ -229,6 +232,9 @@ class MAGNUM_TRADE_EXPORT AbstractSceneConverter: public PluginManager::Abstract
          * Some flags can be set only if the converter supports particular
          * features, see documentation of each @ref SceneConverterFlag for more
          * information. By default no flags are set.
+         *
+         * Corresponds to the `-v` / `--verbose` option in
+         * @ref magnum-sceneconverter "magnum-sceneconverter".
          */
         void setFlags(SceneConverterFlags flags);