Shaders: doc++

src/Magnum/Shaders/DistanceFieldVectorGL.h

@@ -204,8 +204,8 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
          * outline starts. Initial value is @cpp 0.5f @ce, larger values will
          * make the vector art look thinner, smaller will make it look thicker.
          *
-         * The @p end parameter describes where outline ends. If set to value
-         * larger than @p start the outline is not drawn. Initial value is
+         * The @p end parameter describes where outline ends. If set to a value
+         * larger than @p start, the outline is not drawn. Initial value is
          * @cpp 1.0f @ce.
          *
          * @see @ref setOutlineColor()

src/Magnum/Shaders/FlatGL.h

@@ -443,9 +443,8 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
          * @brief Set color
          * @return Reference to self (for method chaining)
          *
-         * If @ref Flag::Textured is set, initial value is
-         * @cpp 0xffffffff_rgbaf @ce and the color will be multiplied with the
-         * texture.
+         * Initial value is @cpp 0xffffffff_rgbaf @ce. If @ref Flag::Textured
+         * is set, the color will be multiplied with the texture.
          * @see @ref bindTexture()
          */
         FlatGL<dimensions>& setColor(const Magnum::Color4& color);

src/Magnum/Shaders/MeshVisualizerGL.h

@@ -277,9 +277,9 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
          *
          * Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either
          * @ref Flag::Wireframe or @ref Flag::InstancedObjectId /
-         * @ref Flag::PrimitiveId is enabled. In case of the latter, the color
-         * is multiplied with the color map coming from
-         * @ref bindColorMapTexture().
+         * @ref Flag::PrimitiveId / @ref Flag::PrimitiveIdFromVertexId is
+         * enabled. In case of the latter, the color is multiplied with the
+         * color map coming from @ref bindColorMapTexture().
          */
         MeshVisualizerGL2D& setColor(const Color4& color) {
             return static_cast<MeshVisualizerGL2D&>(Implementation::MeshVisualizerGLBase::setColor(color));
@@ -300,7 +300,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
          * @brief Set wireframe width
          * @return Reference to self (for method chaining)
          *
-         * Value is in screen space (depending on @ref setViewportSize()),
+         * The value is in screen space (depending on @ref setViewportSize()),
          * initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is
          * enabled.
          */
@@ -891,9 +891,9 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
          *
          * Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either
          * @ref Flag::Wireframe or @ref Flag::InstancedObjectId /
-         * @ref Flag::PrimitiveId is enabled. In case of the latter, the color
-         * is multiplied with the color map coming from
-         * @ref bindColorMapTexture().
+         * @ref Flag::PrimitiveId / @ref Flag::PrimitiveIdFromVertexId is
+         * enabled. In case of the latter, the color is multiplied with the
+         * color map coming from @ref bindColorMapTexture().
          */
         MeshVisualizerGL3D& setColor(const Color4& color) {
             return static_cast<MeshVisualizerGL3D&>(Implementation::MeshVisualizerGLBase::setColor(color));
@@ -914,7 +914,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
          * @brief Set wireframe width
          * @return Reference to self (for method chaining)
          *
-         * Value is in screen space (depending on @ref setViewportSize()),
+         * The value is in screen space (depending on @ref setViewportSize()),
          * initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is
          * enabled.
          */
@@ -963,7 +963,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
          * @return Reference to self (for method chaining)
          * @m_since{2020,06}
          *
-         * Value is in screen space (depending on @ref setViewportSize()),
+         * The value is in screen space (depending on @ref setViewportSize()),
          * initial value is @cpp 1.0f @ce. Expects that
          * @ref Flag::TangentDirection,
          * @ref Flag::BitangentFromTangentDirection,
@@ -982,8 +982,8 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
          * @return Reference to self (for method chaining)
          * @m_since{2020,06}
          *
-         * Value is in object space, initial value is @cpp 1.0f @ce. Expects
-         * that @ref Flag::TangentDirection,
+         * The value is in object space, initial value is @cpp 1.0f @ce.
+         * Expects that @ref Flag::TangentDirection,
          * @ref Flag::BitangentFromTangentDirection,
          * @ref Flag::BitangentDirection or @ref Flag::NormalDirection is
          * enabled.
@@ -1000,7 +1000,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
          * @brief Set line smoothness
          * @return Reference to self (for method chaining)
          *
-         * Value is in screen space (depending on @ref setViewportSize()),
+         * The value is in screen space (depending on @ref setViewportSize()),
          * initial value is @cpp 2.0f @ce. Expects that @ref Flag::Wireframe,
          * @ref Flag::TangentDirection,
          * @ref Flag::BitangentFromTangentDirection,

src/Magnum/Shaders/VectorGL.h

@@ -158,7 +158,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
          * @brief Set transformation and projection matrix
          * @return Reference to self (for method chaining)
          *
-         * Default is an identity matrix.
+         * Initial value is an identity matrix.
          */
         VectorGL<dimensions>& setTransformationProjectionMatrix(const MatrixTypeFor<dimensions, Float>& matrix);
 
@@ -177,7 +177,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
          * @brief Set background color
          * @return Reference to self (for method chaining)
          *
-         * Default is @cpp 0x00000000_rgbaf @ce.
+         * Initial value is @cpp 0x00000000_rgbaf @ce.
          * @see @ref setColor()
          */
         VectorGL<dimensions>& setBackgroundColor(const Color4& color);
@@ -186,7 +186,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
          * @brief Set fill color
          * @return Reference to self (for method chaining)
          *
-         * Default is @cpp 0xffffffff_rgbaf @ce.
+         * Initial value is @cpp 0xffffffff_rgbaf @ce.
          * @see @ref setBackgroundColor()
          */
         VectorGL<dimensions>& setColor(const Color4& color);