From 812e93ae9496239a763a3d1b6b2cf3caa75f75c8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Tue, 11 Jan 2022 10:06:54 +0100
Subject: [PATCH] Doc++

---
 src/Magnum/Mesh.h         |  6 +++---
 src/Magnum/PixelFormat.h  | 13 +++++++------
 src/Magnum/VertexFormat.h | 17 ++++++++---------
 3 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/src/Magnum/Mesh.h b/src/Magnum/Mesh.h
index a37924b7f..62121ba2c 100644
--- a/src/Magnum/Mesh.h
+++ b/src/Magnum/Mesh.h
@@ -216,9 +216,9 @@ constexpr bool isMeshPrimitiveImplementationSpecific(MeshPrimitive primitive) {
 @brief Wrap an implementation-specific mesh primitive identifier in @ref MeshPrimitive
 @m_since{2020,06}
 
-Sets the highest bit on @p primitive to mark it as implementation-specific.
-Expects that @p primitive fits into the remaining bits. Use
-@ref meshPrimitiveUnwrap() for the inverse operation.
+Sets the highest bit on @p implementationSpecific to mark it as
+implementation-specific. Expects that @p implementationSpecific fits into the
+remaining 31 bits. Use @ref meshPrimitiveUnwrap() for the inverse operation.
 @see @ref isMeshPrimitiveImplementationSpecific()
 */
 template<class T> constexpr MeshPrimitive meshPrimitiveWrap(T implementationSpecific) {
diff --git a/src/Magnum/PixelFormat.h b/src/Magnum/PixelFormat.h
index 18768c57e..d2fecd16d 100644
--- a/src/Magnum/PixelFormat.h
+++ b/src/Magnum/PixelFormat.h
@@ -793,9 +793,9 @@ constexpr bool isPixelFormatImplementationSpecific(PixelFormat format) {
 /**
 @brief Wrap an implementation-specific pixel format identifier in @ref PixelFormat
 
-Sets the highest bit on @p format to mark it as implementation-specific.
-Expects that @p format fits into the remaining bits. Use @ref pixelFormatUnwrap()
-for the inverse operation.
+Sets the highest bit on @p implementationSpecific to mark it as
+implementation-specific. Expects that @p implementationSpecific fits into the
+remaining 31 bits. Use @ref pixelFormatUnwrap() for the inverse operation.
 @see @ref isPixelFormatImplementationSpecific(), @ref compressedPixelFormatWrap()
 */
 template<class T> constexpr PixelFormat pixelFormatWrap(T implementationSpecific) {
@@ -2361,9 +2361,10 @@ constexpr bool isCompressedPixelFormatImplementationSpecific(CompressedPixelForm
 /**
 @brief Wrap an implementation-specific pixel format identifier in a @ref CompressedPixelFormat
 
-Sets the highest bit on @p format to mark it as implementation-specific.
-Expects that @p format fits into the remaining bits. Use @ref compressedPixelFormatUnwrap()
-for the inverse operation.
+Sets the highest bit on @p implementationSpecific to mark it as
+implementation-specific. Expects that @p implementationSpecific fits into the
+remaining 31 bits. Use @ref compressedPixelFormatUnwrap() for the inverse
+operation.
 @see @ref isCompressedPixelFormatImplementationSpecific(), @ref pixelFormatWrap()
 */
 template<class T> constexpr CompressedPixelFormat compressedPixelFormatWrap(T implementationSpecific) {
diff --git a/src/Magnum/VertexFormat.h b/src/Magnum/VertexFormat.h
index 87480c185..b0e0cb6d7 100644
--- a/src/Magnum/VertexFormat.h
+++ b/src/Magnum/VertexFormat.h
@@ -42,10 +42,9 @@ namespace Magnum {
 @m_since{2020,06}
 
 Like @ref PixelFormat, but for mesh attributes --- including double-precision
-types and matrices. Can act also as a wrapper for implementation-specific mesh
-attribute type values using @ref vertexFormatWrap() and
-@ref vertexFormatUnwrap(). Distinction between generic and
-implementation-specific types can be done using
+types and matrices. Can act also as a wrapper for implementation-specific
+vertex format values using @ref vertexFormatWrap() and @ref vertexFormatUnwrap().
+Distinction between generic and implementation-specific types can be done using
 @ref isVertexFormatImplementationSpecific().
 
 In case of OpenGL, corresponds to a tuple of @ref GL::DynamicAttribute::Kind,
@@ -1334,9 +1333,9 @@ constexpr bool isVertexFormatImplementationSpecific(VertexFormat format) {
 @brief Wrap an implementation-specific vertex format identifier in @ref VertexFormat
 @m_since{2020,06}
 
-Sets the highest bit on @p type to mark it as implementation-specific. Expects
-that @p type fits into the remaining bits. Use @ref vertexFormatUnwrap()
-for the inverse operation.
+Sets the highest bit on @p implementationSpecific to mark it as
+implementation-specific. Expects that @p implementationSpecific fits into the
+remaining 31 bits. Use @ref vertexFormatUnwrap() for the inverse operation.
 @see @ref isVertexFormatImplementationSpecific()
 */
 template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecific) {
@@ -1350,8 +1349,8 @@ template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecif
 @brief Unwrap an implementation-specific vertex format identifier from @ref VertexFormat
 @m_since{2020,06}
 
-Unsets the highest bit from @p type to extract the implementation-specific
-value. Expects that @p type has it set. Use @ref vertexFormatWrap() for
+Unsets the highest bit from @p format to extract the implementation-specific
+value. Expects that @p format has it set. Use @ref vertexFormatWrap() for
 the inverse operation.
 @see @ref isVertexFormatImplementationSpecific()
 */