From 31c70f2c083d1be40e312482d614768b68b2a9b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 13 Dec 2011 14:55:57 +0100 Subject: [PATCH] Doc++ --- src/Camera.h | 2 +- src/CubeMapTexture.h | 2 +- src/Image.h | 4 ++-- src/Math/Matrix.h | 2 +- src/Math/Matrix3.h | 2 +- src/Math/Matrix4.h | 2 +- src/Math/Vector.h | 2 +- src/Math/Vector2.h | 2 +- src/Math/Vector3.h | 2 +- src/Math/Vector4.h | 2 +- src/Primitives/Cube.h | 2 +- src/Primitives/Icosphere.h | 2 +- src/Scene.h | 2 +- src/Shader.h | 2 +- src/Texture.h | 11 +++++++++++ 15 files changed, 26 insertions(+), 15 deletions(-) diff --git a/src/Camera.h b/src/Camera.h index 0d6ee7e1c..f509724ca 100644 --- a/src/Camera.h +++ b/src/Camera.h @@ -24,7 +24,7 @@ namespace Magnum { /** - * @brief Camera object + * @brief %Camera object * * @todo Subclasses - perspective, FBO postprocessing etc. */ diff --git a/src/CubeMapTexture.h b/src/CubeMapTexture.h index c2f4c7d14..668ebdf99 100644 --- a/src/CubeMapTexture.h +++ b/src/CubeMapTexture.h @@ -16,7 +16,7 @@ */ /** @file - * @brief Cube map texture + * @brief Class Magnum::CubeMapTexture */ #include "Texture.h" diff --git a/src/Image.h b/src/Image.h index d948c0723..1586e90c7 100644 --- a/src/Image.h +++ b/src/Image.h @@ -16,7 +16,7 @@ */ /** @file - * @brief Class Magnum::Image + * @brief Enum Magnum::ColorFormat, class Magnum::Image */ #include "Magnum.h" @@ -35,7 +35,7 @@ enum class ColorFormat: GLenum { }; /** -@brief Image +@brief %Image Class for storing data, which are later fed to textures. It is just a transparent envelope around the data, which holds additional information about diff --git a/src/Math/Matrix.h b/src/Math/Matrix.h index e1e759939..a1f205336 100644 --- a/src/Math/Matrix.h +++ b/src/Math/Matrix.h @@ -24,7 +24,7 @@ namespace Magnum { namespace Math { /** - * @brief Matrix + * @brief %Matrix * * @todo @c PERFORMANCE - implicit sharing * @todo @c PERFORMANCE - loop unrolling for Matrix and Matrix diff --git a/src/Math/Matrix3.h b/src/Math/Matrix3.h index 4122d3c49..0addd669d 100644 --- a/src/Math/Matrix3.h +++ b/src/Math/Matrix3.h @@ -24,7 +24,7 @@ namespace Magnum { namespace Math { -/** @brief Matrix 3x3 */ +/** @brief 3x3 matrix */ template class Matrix3: public Matrix { public: /** @copydoc Matrix::Matrix(bool) */ diff --git a/src/Math/Matrix4.h b/src/Math/Matrix4.h index 67e60f129..f80dc38bc 100644 --- a/src/Math/Matrix4.h +++ b/src/Math/Matrix4.h @@ -25,7 +25,7 @@ namespace Magnum { namespace Math { /** - * @brief Matrix 4x4 + * @brief 4x4 matrix * * @todo @c PERFORMANCE - make (T,T,T) - (Vec3<T>) alternatives calling * direction based on statistics, which is used more frequently diff --git a/src/Math/Vector.h b/src/Math/Vector.h index e421a5e68..2ec7dec93 100644 --- a/src/Math/Vector.h +++ b/src/Math/Vector.h @@ -27,7 +27,7 @@ namespace Magnum { namespace Math { -/** @brief Vector */ +/** @brief %Vector */ template class Vector { public: typedef T Type; /**< @brief Vector data type */ diff --git a/src/Math/Vector2.h b/src/Math/Vector2.h index 5b33a429c..03388ce83 100644 --- a/src/Math/Vector2.h +++ b/src/Math/Vector2.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Math { -/** @brief Vector (two-component) */ +/** @brief Two-component vector */ template class Vector2: public Vector { public: /** @copydoc Vector::Vector */ diff --git a/src/Math/Vector3.h b/src/Math/Vector3.h index b99eff31a..c915d3330 100644 --- a/src/Math/Vector3.h +++ b/src/Math/Vector3.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Math { -/** @brief Vector (three-component) */ +/** @brief Three-component vector */ template class Vector3: public Vector { public: /** @brief Unit vector in direction of X axis */ diff --git a/src/Math/Vector4.h b/src/Math/Vector4.h index 01baaeeba..0e62de8b8 100644 --- a/src/Math/Vector4.h +++ b/src/Math/Vector4.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Math { -/** @brief Vector (four-component) */ +/** @brief Four-component vector */ template class Vector4: public Vector { public: /** diff --git a/src/Primitives/Cube.h b/src/Primitives/Cube.h index 181859895..13fe3d4e8 100644 --- a/src/Primitives/Cube.h +++ b/src/Primitives/Cube.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Primitives { -/** @brief Cube primitive */ +/** @brief %Cube primitive */ class Cube: public AbstractPrimitive { public: inline Mesh::Primitive primitive() const { return Mesh::Triangles; } diff --git a/src/Primitives/Icosphere.h b/src/Primitives/Icosphere.h index 4eb6e74e8..fce67e5a0 100644 --- a/src/Primitives/Icosphere.h +++ b/src/Primitives/Icosphere.h @@ -37,7 +37,7 @@ class _AbstractIcosphere { #endif /** - * @brief Icosphere primitive + * @brief %Icosphere primitive * @tparam subdivisions Number of subdivisions */ template class Icosphere: public AbstractPrimitive::value*20*3>::value>::SizeType>, _AbstractIcosphere { diff --git a/src/Scene.h b/src/Scene.h index 1ee1677aa..76a8736f0 100644 --- a/src/Scene.h +++ b/src/Scene.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @brief Scene */ +/** @brief %Scene */ class Scene: public Object { private: virtual void setParent(Object* parent) {} diff --git a/src/Shader.h b/src/Shader.h index 1da54dae6..5da07a2f5 100644 --- a/src/Shader.h +++ b/src/Shader.h @@ -27,7 +27,7 @@ namespace Magnum { /** - * @brief Shader + * @brief %Shader * * Allows loading and compiling the shader from file or directly from source * string. Compiled shaders are then passed to AbstractShaderProgram subclasses diff --git a/src/Texture.h b/src/Texture.h index 8998d55a0..e3ff77a07 100644 --- a/src/Texture.h +++ b/src/Texture.h @@ -82,6 +82,8 @@ template class Texture: public AbstractTexture { * @param colorFormat Color format of passed data. Data size per * color channel is detected from format of passed data array. * @param data %Texture data + * + * Sets texture from given data. The data are not deleted afterwards. */ template inline void setData(GLint mipLevel, InternalFormat internalFormat, const Math::Vector& _dimensions, ColorFormat colorFormat, const T* data) { bind(); @@ -94,6 +96,9 @@ template class Texture: public AbstractTexture { * @param mipLevel Mip level * @param internalFormat Internal texture format * @param image Image + * + * Sets texture data from given image. The image is not deleted + * afterwards. */ inline void setData(GLint mipLevel, InternalFormat internalFormat, const Image* image) { bind(); @@ -109,6 +114,9 @@ template class Texture: public AbstractTexture { * @param colorFormat Color format of passed data. Data size per * color channel is detected from format of passed data array. * @param data %Texture data + * + * Sets texture subdata from given data. The data are not deleted + * afterwards. */ template inline void setSubData(GLint mipLevel, const Math::Vector& offset, const Math::Vector& _dimensions, ColorFormat colorFormat, const T* data) { bind(); @@ -121,6 +129,9 @@ template class Texture: public AbstractTexture { * @param mipLevel Mip level * @param offset Offset where to put data in the texture * @param image Image + * + * Sets texture subdata from given image. The image is not deleted + * afterwards. */ inline void setSubData(GLint mipLevel, const Math::Vector& offset, const Image* image) { bind();