From ce09e50e05d3933efd62835dd7a30cae8d593471 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 22 May 2012 16:07:12 +0200 Subject: [PATCH] Doc: Using @relates for texture internal format operator|. --- src/AbstractTexture.h | 11 +++++++---- src/BufferedTexture.h | 8 ++++++-- src/Renderbuffer.h | 8 ++++++-- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index 1e984d3cb..d2162fd07 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -568,13 +568,16 @@ class MAGNUM_EXPORT AbstractTexture { GLuint texture; }; - - -/** @brief Convertor of component count and data type to InternalFormat */ +/** @relates AbstractTexture +@brief Convertor of component count and data type to InternalFormat +*/ inline AbstractTexture::InternalFormat operator|(AbstractTexture::Components components, AbstractTexture::ComponentType type) { return AbstractTexture::InternalFormat(components, type); } -/** @brief Convertor of component count and data type to InternalFormat */ + +/** @relates AbstractTexture + * @overload + */ inline AbstractTexture::InternalFormat operator|(AbstractTexture::ComponentType type, AbstractTexture::Components components) { return AbstractTexture::InternalFormat(components, type); } diff --git a/src/BufferedTexture.h b/src/BufferedTexture.h index e17ad6f6d..c29f69c99 100644 --- a/src/BufferedTexture.h +++ b/src/BufferedTexture.h @@ -148,11 +148,15 @@ class BufferedTexture { GLuint texture; }; -/** @copydoc operator|(AbstractTexture::Components, AbstractTexture::ComponentType) */ +/** @relates BufferedTexture +@brief Convertor of component count and data type to InternalFormat +*/ inline BufferedTexture::InternalFormat operator|(BufferedTexture::Components components, BufferedTexture::ComponentType type) { return BufferedTexture::InternalFormat(components, type); } -/** @copydoc operator|(AbstractTexture::ComponentType, AbstractTexture::Components) */ +/** @relates BufferedTexture + * @overload + */ inline BufferedTexture::InternalFormat operator|(BufferedTexture::ComponentType type, BufferedTexture::Components components) { return BufferedTexture::InternalFormat(components, type); } diff --git a/src/Renderbuffer.h b/src/Renderbuffer.h index 8d6970e8c..04f00f94a 100644 --- a/src/Renderbuffer.h +++ b/src/Renderbuffer.h @@ -146,11 +146,15 @@ class Renderbuffer { GLuint renderbuffer; }; -/** @copydoc operator|(AbstractTexture::Components, AbstractTexture::ComponentType) */ +/** @relates Renderbuffer +@brief Convertor of component count and data type to InternalFormat +*/ inline Renderbuffer::InternalFormat operator|(Renderbuffer::Components components, Renderbuffer::ComponentType type) { return Renderbuffer::InternalFormat(components, type); } -/** @copydoc operator|(AbstractTexture::ComponentType, AbstractTexture::Components) */ +/** @relates Renderbuffer + * @overload + */ inline Renderbuffer::InternalFormat operator|(Renderbuffer::ComponentType type, Renderbuffer::Components components) { return Renderbuffer::InternalFormat(components, type); }