Browse Source

Doc++

Forgot to check doc generation before pushing, ug.
pull/594/head
Vladimír Vondruš 4 years ago
parent
commit
b01f8765e9
  1. 8
      src/Magnum/SceneTools/sceneconverter.cpp
  2. 29
      src/Magnum/Trade/AbstractSceneConverter.h

8
src/Magnum/SceneTools/sceneconverter.cpp

@ -203,11 +203,11 @@ It's possible to specify the `-C` option (and correspondingly also `-c`)
multiple times in order to chain more converters together. All converters in multiple times in order to chain more converters together. All converters in
the chain have to support the the chain have to support the
@ref Trade::SceneConverterFeature::ConvertMultiple or @ref Trade::SceneConverterFeature::ConvertMultiple or
@relativeref{Trade::SceneCOnverterFeature,ConvertMesh} feature, the last @relativeref{Trade::SceneConverterFeature,ConvertMesh} feature, the last
converter either @ref Trade::SceneConverterFeature::ConvertMultiple, converter either @ref Trade::SceneConverterFeature::ConvertMultiple,
@relativeref{Trade::SceneCOnverterFeature,ConvertMesh}, @relativeref{Trade::SceneConverterFeature,ConvertMesh},
@relativeref{Trade::SceneCOnverterFeature,ConvertMultipleToFile} or @relativeref{Trade::SceneConverterFeature,ConvertMultipleToFile} or
@relativeref{Trade::SceneCOnverterFeature,ConvertMeshToFile}. If the last @relativeref{Trade::SceneConverterFeature,ConvertMeshToFile}. If the last
converter doesn't support conversion to a file, converter doesn't support conversion to a file,
@relativeref{Trade,AnySceneConverter} is used to save its output. If no `-C` is @relativeref{Trade,AnySceneConverter} is used to save its output. If no `-C` is
specified, @relativeref{Trade,AnySceneConverter} is used. specified, @relativeref{Trade,AnySceneConverter} is used.

29
src/Magnum/Trade/AbstractSceneConverter.h

@ -329,8 +329,8 @@ MAGNUM_TRADE_EXPORT Debug& operator<<(Debug& debug, SceneConverterFlags value);
Content to be taken from an @ref AbstractImporter and passed to an Content to be taken from an @ref AbstractImporter and passed to an
@ref AbstractSceneConverter in @ref AbstractSceneConverter::addImporterContents() @ref AbstractSceneConverter in @ref AbstractSceneConverter::addImporterContents()
and @relativeref{AbstractSceneConverter,addSupportedImporterContents()}. and @relativeref{AbstractSceneConverter,addSupportedImporterContents()}.
@see @ref SceneContents, @ref sceneContentsFor(AbstractImporter&), @see @ref SceneContents, @ref sceneContentsFor(const AbstractImporter&),
@ref sceneContentsFor(AbstractSceneConverter&) @ref sceneContentsFor(const AbstractSceneConverter&)
*/ */
enum class SceneContent: UnsignedInt { enum class SceneContent: UnsignedInt {
/** @todo needs to be taken by addScene(), addMaterial() and addTexture() /** @todo needs to be taken by addScene(), addMaterial() and addTexture()
@ -484,8 +484,8 @@ enum class SceneContent: UnsignedInt {
Content to be taken from an @ref AbstractImporter and passed to an Content to be taken from an @ref AbstractImporter and passed to an
@ref AbstractSceneConverter in @ref AbstractSceneConverter::addImporterContents() @ref AbstractSceneConverter in @ref AbstractSceneConverter::addImporterContents()
and @relativeref{AbstractSceneConverter,addSupportedImporterContents()}. and @relativeref{AbstractSceneConverter,addSupportedImporterContents()}.
@see @ref sceneContentsFor(AbstractImporter&), @see @ref sceneContentsFor(const AbstractImporter&),
@ref sceneContentsFor(AbstractSceneConverter&) @ref sceneContentsFor(const AbstractSceneConverter&)
*/ */
typedef Containers::EnumSet<SceneContent> SceneContents; typedef Containers::EnumSet<SceneContent> SceneContents;
@ -513,7 +513,7 @@ returns a non-zero count. Expects that the importer is opened.
involves parsing additional files and thus may be time- and memory-consuming involves parsing additional files and thus may be time- and memory-consuming
operation, @ref SceneContent::MeshLevels and operation, @ref SceneContent::MeshLevels and
@relativeref{SceneContent,ImageLevels} is never present. @relativeref{SceneContent,ImageLevels} is never present.
@see @ref sceneContentsFor(AbstractSceneConverter&), @see @ref sceneContentsFor(const AbstractSceneConverter&),
@ref AbstractImporter::isOpened() @ref AbstractImporter::isOpened()
*/ */
MAGNUM_TRADE_EXPORT SceneContents sceneContentsFor(const AbstractImporter& importer); MAGNUM_TRADE_EXPORT SceneContents sceneContentsFor(const AbstractImporter& importer);
@ -525,7 +525,7 @@ MAGNUM_TRADE_EXPORT SceneContents sceneContentsFor(const AbstractImporter& impor
Returns contents supported by given converter, as exposed via Returns contents supported by given converter, as exposed via
@ref AbstractSceneConverter::features(). @ref SceneContent::Names is present @ref AbstractSceneConverter::features(). @ref SceneContent::Names is present
always. always.
@see @ref sceneContentsFor(AbstractImporter&) @see @ref sceneContentsFor(const AbstractImporter&)
*/ */
MAGNUM_TRADE_EXPORT SceneContents sceneContentsFor(const AbstractSceneConverter& converter); MAGNUM_TRADE_EXPORT SceneContents sceneContentsFor(const AbstractSceneConverter& converter);
@ -1957,11 +1957,12 @@ class MAGNUM_TRADE_EXPORT AbstractSceneConverter: public PluginManager::Abstract
* *
* Expects that a conversion is currently in progress and @p importer * Expects that a conversion is currently in progress and @p importer
* is opened. The union of @p contents and * is opened. The union of @p contents and
* @ref sceneContentsFor(AbstractImporter&) for @p importer is expected * @ref sceneContentsFor(const AbstractImporter&) for @p importer is
* to be a subset of @ref sceneContentsFor(AbstractSceneConverter&) for * expected to be a subset of
* this converter --- i.e., there shouldn't be any data that the * @ref sceneContentsFor(const AbstractSceneConverter&) for this
* converter doesn't support. Any @p contents that are not in * converter --- i.e., there shouldn't be any data that the converter
* @ref sceneContentsFor(AbstractImporter&) for @p importer are * doesn't support. Any @p contents that are not in
* @ref sceneContentsFor(const AbstractImporter&) for @p importer are
* ignored. If you want to add just contents supported by the coverter * ignored. If you want to add just contents supported by the coverter
* and ignore the rest with a warning, use * and ignore the rest with a warning, use
* @ref addSupportedImporterContents() instead. * @ref addSupportedImporterContents() instead.
@ -1997,9 +1998,9 @@ class MAGNUM_TRADE_EXPORT AbstractSceneConverter: public PluginManager::Abstract
* *
* Compared to @ref addImporterContents(), data not supported by the * Compared to @ref addImporterContents(), data not supported by the
* converter (i.e., @p contents that are in * converter (i.e., @p contents that are in
* @ref sceneContentsFor(AbstractImporter&) for @p importer but are not * @ref sceneContentsFor(const AbstractImporter&) for @p importer but
* in @ref sceneContentsFor(AbstractSceneConverter&) for the * are not in @ref sceneContentsFor(const AbstractSceneConverter&) for
* converter) are ignored with a message printed to * the converter) are ignored with a message printed to
* @relativeref{Magnum,Warning}. * @relativeref{Magnum,Warning}.
* *
* In case of @ref SceneContent::MeshLevels / * In case of @ref SceneContent::MeshLevels /

Loading…
Cancel
Save