From 95725cae94e890f6f78b17c3bd5a64557996a6a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 17 May 2012 21:40:22 +0200 Subject: [PATCH] Workaround Doxygen parsing bug. Probably caused by MAGNUM_EXPORT macro. --- src/AbstractTexture.h | 60 +++++++++++++++++++++---------------------- src/Camera.h | 7 ++++- src/Mesh.h | 12 +++++++-- 3 files changed, 46 insertions(+), 33 deletions(-) diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index b433445c2..3b6b4622a 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -414,7 +414,36 @@ class MAGNUM_EXPORT AbstractTexture { Depth32FloatStencil8 = GL_DEPTH32F_STENCIL8 }; - class InternalFormat; + /** + * @brief Internal format + * + * When specifying internal format, you can either specify as binary + * OR of component count (using Component enum) and data type per + * component (value from ComponentType enum), or using one of named + * internal formats from Format enum, e.g.: + * @code + * InternalFormat fmt1 = Format::RGBA; + * InternalFormat fmt2 = Components::RGBA|ComponentType::NormalizedUnsignedByte; + * @endcode + * You can also use the constructor directly instead of binary OR: + * @code + * InternalFormat fmt2(Components::RGBA, ComponentType::NormalizedUnsignedByte); + * @endcode + */ + class MAGNUM_EXPORT InternalFormat { + public: + /** @brief Constructor from component count and data type per component */ + InternalFormat(Components components, ComponentType type); + + /** @brief Constructor from named internal format */ + inline constexpr InternalFormat(Format format): internalFormat(static_cast(format)) {} + + /** @brief OpenGL internal format ID */ + inline constexpr operator GLint() const { return internalFormat; } + + private: + GLint internalFormat; + }; /*@}*/ @@ -539,36 +568,7 @@ class MAGNUM_EXPORT AbstractTexture { GLuint texture; }; -/** -@brief Internal format - -When specifying internal format, you can either specify as binary OR of -component count (using Component enum) and data type per component (value from -ComponentType enum), or using one of named internal formats from Format enum, -e.g.: -@code -InternalFormat fmt1 = Format::RGBA; -InternalFormat fmt2 = Components::RGBA|ComponentType::NormalizedUnsignedByte; -@endcode -You can also use the constructor directly instead of binary OR: -@code -InternalFormat fmt2(Components::RGBA, ComponentType::NormalizedUnsignedByte); -@endcode -*/ -class MAGNUM_EXPORT AbstractTexture::InternalFormat { - public: - /** @brief Constructor from component count and data type per component */ - InternalFormat(Components components, ComponentType type); - - /** @brief Constructor from named internal format */ - inline constexpr InternalFormat(Format format): internalFormat(static_cast(format)) {} - /** @brief OpenGL internal format ID */ - inline constexpr operator GLint() const { return internalFormat; } - - private: - GLint internalFormat; -}; /** @brief Convertor of component count and data type to InternalFormat */ inline AbstractTexture::InternalFormat operator|(AbstractTexture::Components components, AbstractTexture::ComponentType type) { diff --git a/src/Camera.h b/src/Camera.h index 37dcd5090..60deb9521 100644 --- a/src/Camera.h +++ b/src/Camera.h @@ -37,6 +37,7 @@ class MAGNUM_EXPORT Camera: public Object { * @brief Features * * If not specified otherwise, all features are disabled by default. + * @see setFeature() */ enum class Feature: GLenum { AlphaBlending = GL_BLEND, /**< Alpha blending */ @@ -53,7 +54,11 @@ class MAGNUM_EXPORT Camera: public Object { FaceCulling = GL_CULL_FACE /**< Back face culling */ }; - /** @brief Aspect ratio policy */ + /** + * @brief Aspect ratio policy + * + * @see aspectRatioPolicy(), setAspectRatioPolicy() + */ enum class AspectRatioPolicy { NotPreserved, /**< Don't preserve aspect ratio */ Extend, /**< Extend on larger side of view */ diff --git a/src/Mesh.h b/src/Mesh.h index baf041ba4..7e31884a1 100644 --- a/src/Mesh.h +++ b/src/Mesh.h @@ -52,7 +52,11 @@ class MAGNUM_EXPORT Mesh { Mesh& operator=(Mesh&& other) = delete; public: - /** @brief Polygon mode */ + /** + * @brief Polygon mode + * + * @see setPolygonMode() + */ enum class PolygonMode: GLenum { /** * Interior of the polygon is filled. @@ -71,7 +75,11 @@ class MAGNUM_EXPORT Mesh { Point = GL_POINT }; - /** @brief Primitive type */ + /** + * @brief Primitive type + * + * @see primitive(), setPrimitive() + */ enum class Primitive: GLenum { /** * Single points