Browse Source

Doc++

Just fixing minor consistency issues found when exposing these APIs to
Python.
pull/595/head
Vladimír Vondruš 4 years ago
parent
commit
17638a2ad5
  1. 8
      src/Magnum/Image.h
  2. 4
      src/Magnum/ImageView.h
  3. 2
      src/Magnum/Trade/ImageData.h
  4. 10
      src/Magnum/Trade/MeshData.h

8
src/Magnum/Image.h

@ -407,7 +407,7 @@ template<UnsignedInt dimensions> class Image {
std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const; std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const;
/** /**
* @brief Image data * @brief Raw image data
* *
* @see @ref release(), @ref pixels() * @see @ref release(), @ref pixels()
*/ */
@ -417,7 +417,7 @@ template<UnsignedInt dimensions> class Image {
Containers::ArrayView<const char> data() const & { return _data; } Containers::ArrayView<const char> data() const & { return _data; }
/** /**
* @brief Image data from a r-value * @brief Raw image data from a r-value
* @m_since{2019,10} * @m_since{2019,10}
* *
* Unlike @ref data(), which returns a view, this is equivalent to * Unlike @ref data(), which returns a view, this is equivalent to
@ -687,7 +687,7 @@ template<UnsignedInt dimensions> class CompressedImage {
std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const; std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const;
/** /**
* @brief Raw data * @brief Raw image ddata
* *
* @see @ref release() * @see @ref release()
*/ */
@ -697,7 +697,7 @@ template<UnsignedInt dimensions> class CompressedImage {
Containers::ArrayView<const char> data() const & { return _data; } Containers::ArrayView<const char> data() const & { return _data; }
/** /**
* @brief Raw data from a r-value * @brief Raw image data from a r-value
* @m_since{2019,10} * @m_since{2019,10}
* *
* Unlike @ref data(), which returns a view, this is equivalent to * Unlike @ref data(), which returns a view, this is equivalent to

4
src/Magnum/ImageView.h

@ -455,7 +455,7 @@ template<UnsignedInt dimensions, class T> class ImageView {
std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const; std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const;
/** /**
* @brief Image data * @brief Raw image data
* *
* @see @ref pixels() * @see @ref pixels()
*/ */
@ -853,7 +853,7 @@ template<UnsignedInt dimensions, class T> class CompressedImageView {
*/ */
std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const; std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const;
/** @brief Image data */ /** @brief Raw image data */
Containers::ArrayView<Type> data() const { return _data; } Containers::ArrayView<Type> data() const { return _data; }
#ifdef MAGNUM_BUILD_DEPRECATED #ifdef MAGNUM_BUILD_DEPRECATED

2
src/Magnum/Trade/ImageData.h

@ -737,7 +737,7 @@ template<UnsignedInt dimensions> class ImageData {
needless state changes -- thus the calculation can't be done */ needless state changes -- thus the calculation can't be done */
/** /**
* @brief Image data * @brief Raw image data
* *
* @see @ref release(), @ref pixels() * @see @ref release(), @ref pixels()
*/ */

10
src/Magnum/Trade/MeshData.h

@ -1216,7 +1216,7 @@ class MAGNUM_TRADE_EXPORT MeshData {
Short indexStride() const; Short indexStride() const;
/** /**
* @brief Mesh indices * @brief Indices
* *
* For an indexed mesh, the second dimension represent the actual data * For an indexed mesh, the second dimension represent the actual data
* type (its size is equal to type size for known @ref MeshIndexType * type (its size is equal to type size for known @ref MeshIndexType
@ -1235,7 +1235,7 @@ class MAGNUM_TRADE_EXPORT MeshData {
Containers::StridedArrayView2D<const char> indices() const; Containers::StridedArrayView2D<const char> indices() const;
/** /**
* @brief Mutable mesh indices * @brief Mutable indices
* *
* Like @ref indices() const, but returns a mutable view. Expects that * Like @ref indices() const, but returns a mutable view. Expects that
* the mesh is mutable. * the mesh is mutable.
@ -1244,7 +1244,7 @@ class MAGNUM_TRADE_EXPORT MeshData {
Containers::StridedArrayView2D<char> mutableIndices(); Containers::StridedArrayView2D<char> 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 * Expects that the mesh is indexed and that @p T corresponds to
* @ref indexType(). In rare cases the first dimension stride may be * @ref indexType(). In rare cases the first dimension stride may be
@ -1259,7 +1259,7 @@ class MAGNUM_TRADE_EXPORT MeshData {
template<class T> Containers::StridedArrayView1D<const T> indices() const; template<class T> Containers::StridedArrayView1D<const T> 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 * Like @ref indices() const, but returns a mutable view. Expects that
* the mesh is mutable. * the mesh is mutable.
@ -1268,7 +1268,7 @@ class MAGNUM_TRADE_EXPORT MeshData {
template<class T> Containers::StridedArrayView1D<T> mutableIndices(); template<class T> Containers::StridedArrayView1D<T> mutableIndices();
/** /**
* @brief Mesh vertex count * @brief Vertex count
* *
* Count of elements in every attribute array returned by * Count of elements in every attribute array returned by
* @ref attribute() (or, in case of an attribute-less mesh, the * @ref attribute() (or, in case of an attribute-less mesh, the

Loading…
Cancel
Save