From 17f79deca8680ee38c67842772d5676d2a54e9bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 26 Nov 2023 18:38:47 +0100 Subject: [PATCH] Trade: doc++ --- src/Magnum/Trade/MaterialData.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/Magnum/Trade/MaterialData.h b/src/Magnum/Trade/MaterialData.h index e34bd4dc2..b00eeef66 100644 --- a/src/Magnum/Trade/MaterialData.h +++ b/src/Magnum/Trade/MaterialData.h @@ -1470,7 +1470,7 @@ class MAGNUM_TRADE_EXPORT MaterialAttributeData { > /*implicit*/ MaterialAttributeData(MaterialAttribute name, const T& value) noexcept: MaterialAttributeData{name, Implementation::MaterialAttributeTypeFor::type(), &value} {} /** - * @brief Construct with a predefined name and string value + * @brief Construct with a predefined name and a string value * @param name Attribute name * @param value Attribute value * @@ -1497,21 +1497,22 @@ class MAGNUM_TRADE_EXPORT MaterialAttributeData { * @ref MaterialAttributeType::Buffer, copies a number of bytes * according to @ref materialAttributeTypeSize() from @p value. The * @p name together with @p value is expected to fit into 62 bytes. + * Note that in case of a @ref MaterialAttributeType::Pointer or a + * @ref MaterialAttributeType::MutablePointer, takes a + * *pointer to a pointer*, not the pointer value itself. * * In case @p type is @ref MaterialAttributeType::String, @p value is * expected to point to a @ref Containers::StringView. The combined * length of @p name and @p value strings is expected to fit into 60 - * bytes. - * - * In case @p type is @ref MaterialAttributeType::String, @p value is - * expected to point to a @relativeref{Corrade,Containers::ArrayView}. - * The combined length of @p name and @p value views is expected to fit - * into 61 bytes. + * bytes. In case @p type is @ref MaterialAttributeType::Buffer, + * @p value is expected to point to a + * @relativeref{Corrade,Containers::ArrayView}. The combined length of + * @p name and @p value views is expected to fit into 61 bytes. */ /*implicit*/ MaterialAttributeData(Containers::StringView name, MaterialAttributeType type, const void* value) noexcept; /** - * @brief Construct with a predefined name + * @brief Construct with a predefined name and a type-erased value * @param name Attribute name * @param type Attribute type * @param value Attribute value