From e86c2a74264d06b2e629514c23e5e4cbfee5fd7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 23 Apr 2024 09:37:56 -0700 Subject: [PATCH] Text: document failure state of AbstractFont::createGlyphCache() as well. It's not used by (the currently only implementation in) MagnumFont, but such behavior makes sense, so have it pinned down in docs. --- src/Magnum/Text/AbstractFont.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/Magnum/Text/AbstractFont.h b/src/Magnum/Text/AbstractFont.h index 35699a87a..e65069b8d 100644 --- a/src/Magnum/Text/AbstractFont.h +++ b/src/Magnum/Text/AbstractFont.h @@ -516,6 +516,11 @@ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin { * Available only if @ref FontFeature::PreparedGlyphCache is supported. * Other fonts support only partial glyph cache filling, see * @ref fillGlyphCache(). Expects that a font is opened. + * + * On success returns an instance of a newly created glyph cache. On + * failure, for example if a file containing glyph cache data cannot be + * open, prints a message to @relativeref{Magnum,Error} and returns + * @cpp nullptr @ce. */ Containers::Pointer createGlyphCache();