From 451909575c6bee9e57c5ba7b845b01d46bc4fb00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 12 Apr 2022 20:07:09 +0200 Subject: [PATCH] ShaderTools,Trade: no longer say we return an empty Array on error. Forgot to update the docs in 51f7862e00ea8df0e674487c23b95287e8a46c39. --- src/Magnum/ShaderTools/AbstractConverter.h | 9 ++++----- src/Magnum/Trade/AbstractImageConverter.h | 9 ++++----- src/Magnum/Trade/AbstractSceneConverter.h | 9 ++++----- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/src/Magnum/ShaderTools/AbstractConverter.h b/src/Magnum/ShaderTools/AbstractConverter.h index 7a1f96f1f..556533510 100644 --- a/src/Magnum/ShaderTools/AbstractConverter.h +++ b/src/Magnum/ShaderTools/AbstractConverter.h @@ -336,11 +336,10 @@ converter plugins. As each converter has different requirements on the source, its format and options set, you're expected to perform error handling on the application side --- if a conversion or linking fails, you get an empty -@relativeref{Corrade,Containers::Optional} / -@relativeref{Corrade,Containers::Array} or @cpp false @ce and a reason printed -to the error output. Everything else (using a feature not implemented in the -converter, ...) is treated as a programmer error and will produce the usual -assertions. +@relativeref{Corrade,Containers::Optional} or @cpp false @ce and a reason +printed to @relativeref{Magnum,Error}. Everything else (using a feature not +implemented in the converter, ...) is treated as a programmer error and will +produce the usual assertions. @m_class{m-note m-success} diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index e2fb74bd9..312ea0e21 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -492,11 +492,10 @@ what the particular converter supports, @ref convertToFile(), As each converter has different requirements and supports different pixel formats, you're expected to perform error handling on the application side --- if a conversion fails, you get an empty -@relativeref{Corrade,Containers::Optional} / -@relativeref{Corrade,Containers::Array} or @cpp false @ce and a reason printed -to the error output. Everything else (using a feature not implemented in the -converter, ...) is treated as a programmer error and will produce the usual -assertions. +@relativeref{Corrade,Containers::Optional} or @cpp false @ce and a reason +printed to @relativeref{Magnum,Error}. Everything else (using a feature not +implemented in the converter, ...) is treated as a programmer error and will +produce the usual assertions. @subsection Trade-AbstractImageConverter-usage-file Saving an image to a file diff --git a/src/Magnum/Trade/AbstractSceneConverter.h b/src/Magnum/Trade/AbstractSceneConverter.h index 14d03ad4d..131217d25 100644 --- a/src/Magnum/Trade/AbstractSceneConverter.h +++ b/src/Magnum/Trade/AbstractSceneConverter.h @@ -192,11 +192,10 @@ what the particular converter supports, @ref convertToFile(), As each converter has different requirements on the input data layout and vertex formats, you're expected to perform error handling on the application side --- if a conversion fails, you get an empty -@relativeref{Corrade,Containers::Optional} / -@relativeref{Corrade,Containers::Array} or @cpp false @ce and a reason printed -to the error output. Everything else (using a feature not implemented in the -converter, ...) is treated as a programmer error and will produce the usual -assertions. +@relativeref{Corrade,Containers::Optional} or @cpp false @ce and a reason +printed to @relativeref{Magnum,Error}. Everything else (using a feature not +implemented in the converter, ...) is treated as a programmer error and will +produce the usual assertions. @subsection Trade-AbstractSceneConverter-usage-file Saving a mesh to a file