From a73e4475451800108bfd6db9e1d7cdbb19c7b435 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 25 Sep 2016 10:54:08 +0200 Subject: [PATCH] Doxygen warning cleanup. --- src/Magnum/Audio/AbstractImporter.h | 8 ++++---- src/Magnum/Math/TypeTraits.h | 4 +++- src/Magnum/Text/AbstractFontConverter.h | 8 ++++---- src/Magnum/Trade/AbstractImageConverter.h | 8 ++++---- src/Magnum/Trade/AbstractImporter.h | 8 ++++---- src/Magnum/Trade/LightData.h | 1 + 6 files changed, 20 insertions(+), 17 deletions(-) diff --git a/src/Magnum/Audio/AbstractImporter.h b/src/Magnum/Audio/AbstractImporter.h index 1e069f2e5..3d6b9ef1f 100644 --- a/src/Magnum/Audio/AbstractImporter.h +++ b/src/Magnum/Audio/AbstractImporter.h @@ -62,10 +62,10 @@ checked by the implementation: Plugin interface string is `"cz.mosra.magnum.Audio.AbstractImporter/0.1"`. -@attention @ref Containers::Array instances returned from the plugin should - *not* use anything else than the default deleter, otherwise this can cause - dangling function pointer call on array destruction if the plugin gets - unloaded before the array is destroyed. +@attention @ref Corrade::Containers::Array instances returned from the plugin + should *not* use anything else than the default deleter, otherwise this can + cause dangling function pointer call on array destruction if the plugin + gets unloaded before the array is destroyed. */ class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Audio.AbstractImporter/0.1") diff --git a/src/Magnum/Math/TypeTraits.h b/src/Magnum/Math/TypeTraits.h index 645e81612..ae42fdfe0 100644 --- a/src/Magnum/Math/TypeTraits.h +++ b/src/Magnum/Math/TypeTraits.h @@ -115,7 +115,7 @@ template struct TypeTraits: Implementation::TypeTraitsDefault { * @brief Type name * * Returns a string representation of type name, such as `"UnsignedInt"` - * for @ref UnsignedInt. + * for @ref Magnum::UnsignedInt "UnsignedInt". */ constexpr static const char* name(); @@ -157,6 +157,7 @@ template struct TypeTraits: Implementation::TypeTraitsDefault { /* Integral scalar types */ namespace Implementation { template struct TypeTraitsName; + #ifndef DOXYGEN_GENERATING_OUTPUT #define _c(type) template<> struct TypeTraitsName { \ constexpr static const char* name() { return #type; } \ }; @@ -174,6 +175,7 @@ namespace Implementation { _c(Double) _c(long double) #undef _c + #endif template struct TypeTraitsIntegral: TypeTraitsDefault, TypeTraitsName { constexpr static T epsilon() { return T(1); } diff --git a/src/Magnum/Text/AbstractFontConverter.h b/src/Magnum/Text/AbstractFontConverter.h index 04ceeef0e..5d5c3810c 100644 --- a/src/Magnum/Text/AbstractFontConverter.h +++ b/src/Magnum/Text/AbstractFontConverter.h @@ -70,10 +70,10 @@ checked by the implementation: Plugin interface string is `"cz.mosra.magnum.Text.AbstractFontConverter/0.1.2"`. -@attention @ref Containers::Array instances returned from the plugin should - *not* use anything else than the default deleter, otherwise this can cause - dangling function pointer call on array destruction if the plugin gets - unloaded before the array is destroyed. +@attention @ref Corrade::Containers::Array instances returned from the plugin + should *not* use anything else than the default deleter, otherwise this can + cause dangling function pointer call on array destruction if the plugin + gets unloaded before the array is destroyed. */ class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Text.AbstractFontConverter/0.1.2") diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index 9613d9932..735a4f1ec 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -64,10 +64,10 @@ checked by the implementation: Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1"`. -@attention @ref Containers::Array instances returned from the plugin should - *not* use anything else than the default deleter, otherwise this can cause - dangling function pointer call on array destruction if the plugin gets - unloaded before the array is destroyed. +@attention @ref Corrade::Containers::Array instances returned from the plugin + should *not* use anything else than the default deleter, otherwise this can + cause dangling function pointer call on array destruction if the plugin + gets unloaded before the array is destroyed. */ class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractManagingPlugin { CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1") diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index 2c4ef1d9e..780da4ce3 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -74,10 +74,10 @@ checked by the implementation: Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImporter/0.3"`. -@attention @ref Containers::Array instances returned from the plugin should - *not* use anything else than the default deleter, otherwise this can cause - dangling function pointer call on array destruction if the plugin gets - unloaded before the array is destroyed. +@attention @ref Corrade::Containers::Array instances returned from the plugin + should *not* use anything else than the default deleter, otherwise this can + cause dangling function pointer call on array destruction if the plugin + gets unloaded before the array is destroyed. @todo How to handle casting from std::unique_ptr<> in more convenient way? */ diff --git a/src/Magnum/Trade/LightData.h b/src/Magnum/Trade/LightData.h index 753430379..636491a51 100644 --- a/src/Magnum/Trade/LightData.h +++ b/src/Magnum/Trade/LightData.h @@ -64,6 +64,7 @@ class LightData { /** * @brief Constructor + * @param type Light type * @param color Light color * @param intensity Light intensity * @param importerState Importer-specific state