diff --git a/doc/MainPage.dox b/doc/MainPage.dox index 16f108e3e..4a25c0a52 100644 --- a/doc/MainPage.dox +++ b/doc/MainPage.dox @@ -7,7 +7,7 @@ namespace Magnum {
  • Comprehensive use of C++11 features for security, performance and ease of development.
  • Hierarchical @ref Scene "scene graph" which supports transformation caching for better performance, classes for convenient usage of @ref AbstractShaderProgram "shaders", @ref Buffer "buffers" and @ref Texture "textures".
  • @ref MeshTools "Mesh tools" for cleaning, optimizing and generating meshes.
  • -
  • Collection of pre-made @ref Primitives "graphic primitives" for testing purposes.
  • +
  • Collection of pre-made @ref Primitives "graphic primitives" and @ref Shaders "shaders" for testing purposes.
  • @section BasicUsage Basic usage diff --git a/doc/namespaces.dox b/doc/namespaces.dox new file mode 100644 index 000000000..6d4e967ff --- /dev/null +++ b/doc/namespaces.dox @@ -0,0 +1,5 @@ +/** @namespace Magnum::Shaders +@brief Sample shaders + +Collection of shaders for testing purposes. +*/ diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index b1d365b5e..2cb7d15f1 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -36,7 +36,7 @@ class MAGNUM_EXPORT AbstractTexture { AbstractTexture& operator=(AbstractTexture&& other) = delete; public: - /** @brief Texture filtering */ + /** @brief %Texture filtering */ enum class Filter: GLint { /** * Nearest neighbor filtering @@ -68,7 +68,7 @@ class MAGNUM_EXPORT AbstractTexture { LinearInterpolation = GL_NEAREST_MIPMAP_LINEAR & ~GL_NEAREST }; - /** @brief Texture wrapping on the edge */ + /** @brief %Texture wrapping on the edge */ enum class Wrapping: GLint { /** * Repeat texture. Unavailable on rectangle textures. @@ -138,7 +138,7 @@ class MAGNUM_EXPORT AbstractTexture { glDeleteTextures(1, &texture); } - /** @brief Texture layer */ + /** @brief %Texture layer */ inline GLint layer() const { return _layer; } /** @brief Bind texture for usage / rendering */ diff --git a/src/Shaders/PhongShader.h b/src/Shaders/PhongShader.h index 5fa9a8198..2ef8073c0 100644 --- a/src/Shaders/PhongShader.h +++ b/src/Shaders/PhongShader.h @@ -35,22 +35,22 @@ class PhongShader: public AbstractShaderProgram { /** @brief Constructor */ PhongShader(); - /** @brief Object ambient color */ + /** @brief %Object ambient color */ inline void setAmbientColorUniform(const Vector3& color) { setUniform(ambientColorUniform, color); } - /** @brief Object diffuse color */ + /** @brief %Object diffuse color */ inline void setDiffuseColorUniform(const Vector3& color) { setUniform(diffuseColorUniform, color); } - /** @brief Object specular color */ + /** @brief %Object specular color */ inline void setSpecularColorUniform(const Vector3& color) { setUniform(specularColorUniform, color); } - /** @brief Object shininess */ + /** @brief %Object shininess */ inline void setShininessUniform(GLfloat shininess) { setUniform(shininessUniform, shininess); } @@ -65,22 +65,22 @@ class PhongShader: public AbstractShaderProgram { setUniform(projectionMatrixUniform, matrix); } - /** @brief Light position */ + /** @brief %Light position */ inline void setLightUniform(const Vector3& light) { setUniform(lightUniform, light); } - /** @brief Light ambient color */ + /** @brief %Light ambient color */ inline void setLightAmbientColorUniform(const Vector3& color) { setUniform(lightAmbientColorUniform, color); } - /** @brief Light diffuse color */ + /** @brief %Light diffuse color */ inline void setLightDiffuseColorUniform(const Vector3& color) { setUniform(lightDiffuseColorUniform, color); } - /** @brief Light specular color */ + /** @brief %Light specular color */ inline void setLightSpecularColorUniform(const Vector3& color) { setUniform(lightSpecularColorUniform, color); } diff --git a/src/Trade/Image.h b/src/Trade/Image.h index c3ccf2edc..cc9e00be0 100644 --- a/src/Trade/Image.h +++ b/src/Trade/Image.h @@ -36,7 +36,7 @@ template class Image { Image& operator=(Image&& other) = delete; public: - const static size_t Dimensions = imageDimensions; /**< @brief Image dimension count */ + const static size_t Dimensions = imageDimensions; /**< @brief %Image dimension count */ /** * @brief Constructor