From fb0ef4ec6e80bd5b9db86821252c90a3620e4d23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 12 Apr 2022 22:14:40 +0200 Subject: [PATCH] Trade: doc++ --- src/Magnum/Trade/AbstractImageConverter.h | 2 +- src/Magnum/Trade/AbstractSceneConverter.h | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index 312ea0e21..fce1d5e72 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -610,7 +610,7 @@ checked by the implementation: implementation doesn't work with any of those, it's expected to check that on its own and produce a runtime error. - All @ref doConvertToData() and @ref doConvertToFile() functions taking - multiple (compressed) images are called only the list has at least one + multiple (compressed) images are called only if the list has at least one image, each of the images has a non-zero size, the views are not @cpp nullptr @ce and additionally all views have the same pixel format. Since file formats have varying requirements on image level sizes and their diff --git a/src/Magnum/Trade/AbstractSceneConverter.h b/src/Magnum/Trade/AbstractSceneConverter.h index 131217d25..f65190072 100644 --- a/src/Magnum/Trade/AbstractSceneConverter.h +++ b/src/Magnum/Trade/AbstractSceneConverter.h @@ -269,13 +269,13 @@ The plugin needs to implement the @ref doFeatures() function and one or more of You don't need to do most of the redundant sanity checks, these things are checked by the implementation: -- The function @ref doConvert(const MeshData&) is called only if +- The @ref doConvert(const MeshData&) function is called only if @ref SceneConverterFeature::ConvertMesh is supported. -- The function @ref doConvertInPlace(MeshData&) is called only if +- The @ref doConvertInPlace(MeshData&) function is called only if @ref SceneConverterFeature::ConvertMeshInPlace is supported. -- The function @ref doConvertToData(const MeshData&) is called only if +- The @ref doConvertToData(const MeshData&) function is called only if @ref SceneConverterFeature::ConvertMeshToData is supported. -- The function @ref doConvertToFile(const MeshData&, Containers::StringView) +- The @ref doConvertToFile(const MeshData&, Containers::StringView) function is called only if @ref SceneConverterFeature::ConvertMeshToFile is supported. @@ -283,7 +283,7 @@ checked by the implementation: @par Dangling function pointers on plugin unload As @ref Trade-AbstractSceneConverter-data-dependency "mentioned above", - @ref Corrade::Containers::Array instances returned from plugin + @relativeref{Corrade::Containers,Array} instances returned from plugin implementations are not allowed to use anything else than the default deleter or the deleter used by @ref Trade::ArrayAllocator, otherwise this could cause dangling function pointer call on array destruction if the