From 17638a2ad50094ece8eeb7ad7f9b06033d05d843 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 5 Oct 2022 11:43:01 +0200 Subject: [PATCH] Doc++ Just fixing minor consistency issues found when exposing these APIs to Python. --- src/Magnum/Image.h | 8 ++++---- src/Magnum/ImageView.h | 4 ++-- src/Magnum/Trade/ImageData.h | 2 +- src/Magnum/Trade/MeshData.h | 10 +++++----- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Magnum/Image.h b/src/Magnum/Image.h index 93371cea1..724a8bf98 100644 --- a/src/Magnum/Image.h +++ b/src/Magnum/Image.h @@ -407,7 +407,7 @@ template class Image { std::pair, VectorTypeFor> dataProperties() const; /** - * @brief Image data + * @brief Raw image data * * @see @ref release(), @ref pixels() */ @@ -417,7 +417,7 @@ template class Image { Containers::ArrayView data() const & { return _data; } /** - * @brief Image data from a r-value + * @brief Raw image data from a r-value * @m_since{2019,10} * * Unlike @ref data(), which returns a view, this is equivalent to @@ -687,7 +687,7 @@ template class CompressedImage { std::pair, VectorTypeFor> dataProperties() const; /** - * @brief Raw data + * @brief Raw image ddata * * @see @ref release() */ @@ -697,7 +697,7 @@ template class CompressedImage { Containers::ArrayView data() const & { return _data; } /** - * @brief Raw data from a r-value + * @brief Raw image data from a r-value * @m_since{2019,10} * * Unlike @ref data(), which returns a view, this is equivalent to diff --git a/src/Magnum/ImageView.h b/src/Magnum/ImageView.h index a04d08fb7..c7c8cd0cf 100644 --- a/src/Magnum/ImageView.h +++ b/src/Magnum/ImageView.h @@ -455,7 +455,7 @@ template class ImageView { std::pair, VectorTypeFor> dataProperties() const; /** - * @brief Image data + * @brief Raw image data * * @see @ref pixels() */ @@ -853,7 +853,7 @@ template class CompressedImageView { */ std::pair, VectorTypeFor> dataProperties() const; - /** @brief Image data */ + /** @brief Raw image data */ Containers::ArrayView data() const { return _data; } #ifdef MAGNUM_BUILD_DEPRECATED diff --git a/src/Magnum/Trade/ImageData.h b/src/Magnum/Trade/ImageData.h index 2455028c6..beb6cbcc1 100644 --- a/src/Magnum/Trade/ImageData.h +++ b/src/Magnum/Trade/ImageData.h @@ -737,7 +737,7 @@ template class ImageData { needless state changes -- thus the calculation can't be done */ /** - * @brief Image data + * @brief Raw image data * * @see @ref release(), @ref pixels() */ diff --git a/src/Magnum/Trade/MeshData.h b/src/Magnum/Trade/MeshData.h index e45e32cb2..9fdcd6969 100644 --- a/src/Magnum/Trade/MeshData.h +++ b/src/Magnum/Trade/MeshData.h @@ -1216,7 +1216,7 @@ class MAGNUM_TRADE_EXPORT MeshData { Short indexStride() const; /** - * @brief Mesh indices + * @brief Indices * * For an indexed mesh, the second dimension represent the actual data * type (its size is equal to type size for known @ref MeshIndexType @@ -1235,7 +1235,7 @@ class MAGNUM_TRADE_EXPORT MeshData { Containers::StridedArrayView2D indices() const; /** - * @brief Mutable mesh indices + * @brief Mutable indices * * Like @ref indices() const, but returns a mutable view. Expects that * the mesh is mutable. @@ -1244,7 +1244,7 @@ class MAGNUM_TRADE_EXPORT MeshData { Containers::StridedArrayView2D mutableIndices(); /** - * @brief Mesh indices in a concrete type + * @brief Indices in a concrete type * * Expects that the mesh is indexed and that @p T corresponds to * @ref indexType(). In rare cases the first dimension stride may be @@ -1259,7 +1259,7 @@ class MAGNUM_TRADE_EXPORT MeshData { template Containers::StridedArrayView1D indices() const; /** - * @brief Mutable mesh indices in a concrete type + * @brief Mutable indices in a concrete type * * Like @ref indices() const, but returns a mutable view. Expects that * the mesh is mutable. @@ -1268,7 +1268,7 @@ class MAGNUM_TRADE_EXPORT MeshData { template Containers::StridedArrayView1D mutableIndices(); /** - * @brief Mesh vertex count + * @brief Vertex count * * Count of elements in every attribute array returned by * @ref attribute() (or, in case of an attribute-less mesh, the