From 40cfe060448149d59634c076974838ed2697d56a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 23 Jan 2019 20:56:39 +0100 Subject: [PATCH] Doc++, minor cleanup. --- src/Magnum/Platform/Sdl2Application.h | 3 ++- src/Magnum/Trade/AnimationData.h | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index 41c9bd611..9c10d8b13 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -513,7 +513,8 @@ class Sdl2Application { /** * @brief Underlying window handle * - * Use in case you need to call SDL functionality directly. + * Use in case you need to call SDL functionality directly. Returns + * @cpp nullptr @ce in case the window was not created yet. * @note Not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten". */ SDL_Window* window() { return _window; } diff --git a/src/Magnum/Trade/AnimationData.h b/src/Magnum/Trade/AnimationData.h index 48e46e975..a52b51540 100644 --- a/src/Magnum/Trade/AnimationData.h +++ b/src/Magnum/Trade/AnimationData.h @@ -202,7 +202,7 @@ enum class AnimationTrackTargetType: UnsignedByte { /** * This and all higher values are for importer-specific targets. Can be of * any type, @ref AnimationData::trackTarget() might or might not point to - * an existing object. See documentation of particular importer for + * an existing object. See documentation of a particular importer for * details. */ Custom = 128 @@ -214,8 +214,8 @@ MAGNUM_TRADE_EXPORT Debug& operator<<(Debug& debug, AnimationTrackTargetType val /** @brief Animation track data -Used when constructing @ref AnimationData. Fields can be accessed through its -API. +Convenience type for populating @ref AnimationData. Has no accessors, as the +data are then accessible through @ref AnimationData APIs. @experimental */ class AnimationTrackData { @@ -453,7 +453,7 @@ template> MAGNUM_TRADE_EXPORT auto ani #if !defined(CORRADE_NO_ASSERT) || defined(CORRADE_GRACEFUL_ASSERT) namespace Implementation { /* LCOV_EXCL_START */ - template constexpr AnimationTrackType animationTypeFor(); + template constexpr AnimationTrackType animationTypeFor(); template<> constexpr AnimationTrackType animationTypeFor() { return AnimationTrackType::Bool; } template<> constexpr AnimationTrackType animationTypeFor() { return AnimationTrackType::Float; } template<> constexpr AnimationTrackType animationTypeFor() { return AnimationTrackType::UnsignedInt; }