Browse Source

Doxygen warning cleanup.

pull/176/head
Vladimír Vondruš 10 years ago
parent
commit
a73e447545
  1. 8
      src/Magnum/Audio/AbstractImporter.h
  2. 4
      src/Magnum/Math/TypeTraits.h
  3. 8
      src/Magnum/Text/AbstractFontConverter.h
  4. 8
      src/Magnum/Trade/AbstractImageConverter.h
  5. 8
      src/Magnum/Trade/AbstractImporter.h
  6. 1
      src/Magnum/Trade/LightData.h

8
src/Magnum/Audio/AbstractImporter.h

@ -62,10 +62,10 @@ checked by the implementation:
Plugin interface string is `"cz.mosra.magnum.Audio.AbstractImporter/0.1"`. Plugin interface string is `"cz.mosra.magnum.Audio.AbstractImporter/0.1"`.
@attention @ref Containers::Array instances returned from the plugin should @attention @ref Corrade::Containers::Array instances returned from the plugin
*not* use anything else than the default deleter, otherwise this can cause should *not* use anything else than the default deleter, otherwise this can
dangling function pointer call on array destruction if the plugin gets cause dangling function pointer call on array destruction if the plugin
unloaded before the array is destroyed. gets unloaded before the array is destroyed.
*/ */
class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlugin<AbstractImporter> { class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlugin<AbstractImporter> {
CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Audio.AbstractImporter/0.1") CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Audio.AbstractImporter/0.1")

4
src/Magnum/Math/TypeTraits.h

@ -115,7 +115,7 @@ template<class T> struct TypeTraits: Implementation::TypeTraitsDefault<T> {
* @brief Type name * @brief Type name
* *
* Returns a string representation of type name, such as `"UnsignedInt"` * Returns a string representation of type name, such as `"UnsignedInt"`
* for @ref UnsignedInt. * for @ref Magnum::UnsignedInt "UnsignedInt".
*/ */
constexpr static const char* name(); constexpr static const char* name();
@ -157,6 +157,7 @@ template<class T> struct TypeTraits: Implementation::TypeTraitsDefault<T> {
/* Integral scalar types */ /* Integral scalar types */
namespace Implementation { namespace Implementation {
template<class> struct TypeTraitsName; template<class> struct TypeTraitsName;
#ifndef DOXYGEN_GENERATING_OUTPUT
#define _c(type) template<> struct TypeTraitsName<type> { \ #define _c(type) template<> struct TypeTraitsName<type> { \
constexpr static const char* name() { return #type; } \ constexpr static const char* name() { return #type; } \
}; };
@ -174,6 +175,7 @@ namespace Implementation {
_c(Double) _c(Double)
_c(long double) _c(long double)
#undef _c #undef _c
#endif
template<class T> struct TypeTraitsIntegral: TypeTraitsDefault<T>, TypeTraitsName<T> { template<class T> struct TypeTraitsIntegral: TypeTraitsDefault<T>, TypeTraitsName<T> {
constexpr static T epsilon() { return T(1); } constexpr static T epsilon() { return T(1); }

8
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"`. Plugin interface string is `"cz.mosra.magnum.Text.AbstractFontConverter/0.1.2"`.
@attention @ref Containers::Array instances returned from the plugin should @attention @ref Corrade::Containers::Array instances returned from the plugin
*not* use anything else than the default deleter, otherwise this can cause should *not* use anything else than the default deleter, otherwise this can
dangling function pointer call on array destruction if the plugin gets cause dangling function pointer call on array destruction if the plugin
unloaded before the array is destroyed. gets unloaded before the array is destroyed.
*/ */
class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPlugin { class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPlugin {
CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Text.AbstractFontConverter/0.1.2") CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Text.AbstractFontConverter/0.1.2")

8
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"`. Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1"`.
@attention @ref Containers::Array instances returned from the plugin should @attention @ref Corrade::Containers::Array instances returned from the plugin
*not* use anything else than the default deleter, otherwise this can cause should *not* use anything else than the default deleter, otherwise this can
dangling function pointer call on array destruction if the plugin gets cause dangling function pointer call on array destruction if the plugin
unloaded before the array is destroyed. gets unloaded before the array is destroyed.
*/ */
class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractManagingPlugin<AbstractImageConverter> { class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractManagingPlugin<AbstractImageConverter> {
CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1") CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Trade.AbstractImageConverter/0.2.1")

8
src/Magnum/Trade/AbstractImporter.h

@ -74,10 +74,10 @@ checked by the implementation:
Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImporter/0.3"`. Plugin interface string is `"cz.mosra.magnum.Trade.AbstractImporter/0.3"`.
@attention @ref Containers::Array instances returned from the plugin should @attention @ref Corrade::Containers::Array instances returned from the plugin
*not* use anything else than the default deleter, otherwise this can cause should *not* use anything else than the default deleter, otherwise this can
dangling function pointer call on array destruction if the plugin gets cause dangling function pointer call on array destruction if the plugin
unloaded before the array is destroyed. gets unloaded before the array is destroyed.
@todo How to handle casting from std::unique_ptr<> in more convenient way? @todo How to handle casting from std::unique_ptr<> in more convenient way?
*/ */

1
src/Magnum/Trade/LightData.h

@ -64,6 +64,7 @@ class LightData {
/** /**
* @brief Constructor * @brief Constructor
* @param type Light type
* @param color Light color * @param color Light color
* @param intensity Light intensity * @param intensity Light intensity
* @param importerState Importer-specific state * @param importerState Importer-specific state

Loading…
Cancel
Save