diff --git a/src/Magnum/GL/AbstractFramebuffer.h b/src/Magnum/GL/AbstractFramebuffer.h index 59f3c6ff9..f894670a8 100644 --- a/src/Magnum/GL/AbstractFramebuffer.h +++ b/src/Magnum/GL/AbstractFramebuffer.h @@ -309,7 +309,7 @@ class MAGNUM_GL_EXPORT AbstractFramebuffer { AbstractFramebuffer& setViewport(const Range2Di& rectangle); /** - * @brief Clear specified buffers in framebuffer + * @brief Clear specified buffers in the framebuffer * @param mask Which buffers to clear * @return Reference to self (for method chaining) * @@ -374,7 +374,7 @@ class MAGNUM_GL_EXPORT AbstractFramebuffer { #endif /** - * @brief Read block of pixels from framebuffer to image + * @brief Read block of pixels from the framebuffer to an image * @param rectangle Framebuffer rectangle to read * @param image Image where to put the data * @@ -408,7 +408,7 @@ class MAGNUM_GL_EXPORT AbstractFramebuffer { Image2D read(const Range2Di& rectangle, Image2D&& image); /** - * @brief Read block of pixels from framebuffer to image + * @brief Read block of pixels from the framebuffer to an image view * * Compared to @ref read(const Range2Di&, Image2D&) the function * reads the pixels into the memory provided by @p image, expecting diff --git a/src/Magnum/Magnum.h b/src/Magnum/Magnum.h index 6646ffd61..5913dfcc5 100644 --- a/src/Magnum/Magnum.h +++ b/src/Magnum/Magnum.h @@ -495,22 +495,22 @@ typedef Math::Deg Deg; /** @brief Angle in float radians */ typedef Math::Rad Rad; -/** @brief Float 1D range */ +/** @brief One-dimensional float range */ typedef Math::Range1D Range1D; -/** @brief Float 2D range */ +/** @brief Two-dimensional float range */ typedef Math::Range2D Range2D; -/** @brief Float 3D range */ +/** @brief Three-dimensional float range */ typedef Math::Range3D Range3D; -/** @brief Signed integer 1D range */ +/** @brief One-dimensional signed integer range */ typedef Math::Range1D Range1Di; -/** @brief Signed integer 2D range */ +/** @brief Two-dimensional signed integer range */ typedef Math::Range2D Range2Di; -/** @brief Signed integer 3D range */ +/** @brief Three-dimensional signed integer range */ typedef Math::Range3D Range3Di; /** @brief Float frustum */ @@ -695,13 +695,13 @@ typedef Math::Deg Degd; /** @brief Angle in double radians */ typedef Math::Rad Radd; -/** @brief Double 1D range */ +/** @brief One-dimensional double range */ typedef Math::Range1D Range1Dd; -/** @brief Double 2D range */ +/** @brief Two-dimensional double range */ typedef Math::Range2D Range2Dd; -/** @brief Double 3D range */ +/** @brief Three-dimensional double range */ typedef Math::Range3D Range3Dd; /** @brief Double frustum */ diff --git a/src/Magnum/Math/Range.h b/src/Magnum/Math/Range.h index 4c557ff97..2e77949cb 100644 --- a/src/Magnum/Math/Range.h +++ b/src/Magnum/Math/Range.h @@ -104,9 +104,9 @@ template class Range { constexpr /*implicit*/ Range() noexcept: Range{ZeroInit, typename std::conditional::type{}} {} /** - * @brief Construct zero range + * @brief Construct a zero range * - * Construct zero-size range positioned at origin. + * Construct a zero-size range positioned at origin. */ constexpr explicit Range(ZeroInitT) noexcept: Range{ZeroInit, typename std::conditional::type{}} {} diff --git a/src/Magnum/PixelStorage.h b/src/Magnum/PixelStorage.h index f0be0d821..958e238d8 100644 --- a/src/Magnum/PixelStorage.h +++ b/src/Magnum/PixelStorage.h @@ -106,11 +106,11 @@ class MAGNUM_EXPORT PixelStorage { return *this; } - /** @brief Pixel, row and image skipping */ + /** @brief Pixel, row and image skip */ constexpr Vector3i skip() const { return _skip; } /** - * @brief Set pixel, row and image skipping + * @brief Set pixel, row and image skip * * The Y value is used only for 2D and 3D images, the Z value is used * only for 3D images. Default is @cpp 0 @ce.