diff --git a/src/AbstractFramebuffer.h b/src/AbstractFramebuffer.h index 7b4e2282a..705c8b859 100644 --- a/src/AbstractFramebuffer.h +++ b/src/AbstractFramebuffer.h @@ -25,7 +25,7 @@ */ /** @file - * @brief Class @ref Magnum::AbstractFramebuffer, enum @ref Magnum::FramebufferClear, @ref Magnum::FramebufferBlit, @ref Magnum::FramebufferBlitFilter, @ref Magnum::FramebufferTarget, enum set @ref FramebufferClearMask + * @brief Class @ref Magnum::AbstractFramebuffer, enum @ref Magnum::FramebufferClear, @ref Magnum::FramebufferBlit, @ref Magnum::FramebufferBlitFilter, @ref Magnum::FramebufferTarget, enum set @ref Magnum::FramebufferClearMask */ #include @@ -39,7 +39,7 @@ namespace Magnum { /** @brief Mask for framebuffer clearing -@see AbstractFramebuffer, FramebufferClearMask +@see @ref AbstractFramebuffer, @ref FramebufferClearMask */ enum class FramebufferClear: GLbitfield { Color = GL_COLOR_BUFFER_BIT, /**< Color */ @@ -50,7 +50,7 @@ enum class FramebufferClear: GLbitfield { /** @brief Mask for clearing -@see AbstractFramebuffer::clear() +@see @ref AbstractFramebuffer::clear() */ typedef Containers::EnumSet FramebufferClearMask; @@ -58,7 +58,7 @@ typedef Containers::EnumSet class AbstractShaderProgram::Attribute { * @brief Constructor * @param components Component count * @param dataType Type of passed data. Default is the same as - * type used in shader (e.g. @ref DataType::Integer for - * @ref Vector4i). + * type used in shader (e.g. @ref DataType::Int for @ref Vector4i). * @param dataOptions Data options. Default is no options. */ constexpr Attribute(Components components, DataType dataType = Implementation::Attribute::DefaultDataType, DataOptions dataOptions = DataOptions()): _components(components), _dataType(dataType), _dataOptions(dataOptions) {} diff --git a/src/Color.h b/src/Color.h index 279387dc8..4795dc5bc 100644 --- a/src/Color.h +++ b/src/Color.h @@ -25,7 +25,7 @@ */ /** @file - * @brief Class Magnum::BasicColor3, Magnum::BasicColor4, typedef Magnum::Color3, Magnum::Color4 + * @brief Class @ref Magnum::BasicColor3, @ref Magnum::BasicColor4, typedef @ref Magnum::Color3, @ref Magnum::Color4 */ #include @@ -290,7 +290,7 @@ template class BasicColor3: public Math::Vector3 { * std::tie(hue, saturation, value) = color.toHSV(); * @endcode * - * @see hue(), saturation(), value(), fromHSV() + * @see @ref hue(), @ref saturation(), @ref value(), @ref fromHSV() */ constexpr HSV toHSV() const { return Implementation::toHSV(*this); @@ -300,7 +300,7 @@ template class BasicColor3: public Math::Vector3 { * @brief Hue * @return Hue in range @f$ [0.0, 360.0] @f$. * - * @see saturation(), value(), toHSV(), fromHSV() + * @see @ref saturation(), @ref value(), @ref toHSV(), @ref fromHSV() */ constexpr Math::Deg hue() const { return Math::Deg(Implementation::hue(*this)); @@ -310,7 +310,7 @@ template class BasicColor3: public Math::Vector3 { * @brief Saturation * @return Saturation in range @f$ [0.0, 1.0] @f$. * - * @see hue(), value(), toHSV(), fromHSV() + * @see @ref hue(), @ref value(), @ref toHSV(), @ref fromHSV() */ constexpr FloatingPointType saturation() const { return Implementation::saturation(*this); @@ -320,7 +320,7 @@ template class BasicColor3: public Math::Vector3 { * @brief Value * @return Value in range @f$ [0.0, 1.0] @f$. * - * @see hue(), saturation(), toHSV(), fromHSV() + * @see @ref hue(), @ref saturation(), @ref toHSV(), @ref fromHSV() */ constexpr FloatingPointType value() const { return Implementation::value(*this); @@ -420,7 +420,7 @@ class BasicColor4: public Math::Vector4 { /** * @copydoc BasicColor3::fromHSV() - * @param a Alpha value, defaults to 1.0 for floating-point types + * @param a Alpha value, defaults to `1.0` for floating-point types * and maximum positive value for integral types. */ constexpr static BasicColor4 fromHSV(HSV hsv, T a = Implementation::fullChannel()) { @@ -434,14 +434,14 @@ class BasicColor4: public Math::Vector4 { /** * @brief Default constructor * - * RGB components are set to zero, A component is set to 1.0 for + * RGB components are set to zero, A component is set to `1.0` for * floating-point types and maximum positive value for integral types. */ constexpr /*implicit*/ BasicColor4(): Math::Vector4(T(0), T(0), T(0), Implementation::fullChannel()) {} /** * @copydoc BasicColor3::BasicColor3(T) - * @param alpha Alpha value, defaults to 1.0 for floating-point types + * @param alpha Alpha value, defaults to `1.0` for floating-point types * and maximum positive value for integral types. */ constexpr explicit BasicColor4(T rgb, T alpha = Implementation::fullChannel()): Math::Vector4(rgb, rgb, rgb, alpha) {} @@ -451,7 +451,7 @@ class BasicColor4: public Math::Vector4 { * @param r R value * @param g G value * @param b B value - * @param a A value, defaults to 1.0 for floating-point types and + * @param a A value, defaults to `1.0` for floating-point types and * maximum positive value for integral types. */ constexpr /*implicit*/ BasicColor4(T r, T g, T b, T a = Implementation::fullChannel()): Math::Vector4(r, g, b, a) {} diff --git a/src/DefaultFramebuffer.h b/src/DefaultFramebuffer.h index 3bc545ffd..f264f61f4 100644 --- a/src/DefaultFramebuffer.h +++ b/src/DefaultFramebuffer.h @@ -393,9 +393,11 @@ class MAGNUM_EXPORT DefaultFramebuffer: public AbstractFramebuffer { * @see @fn_gl{InvalidateFramebuffer} or @fn_gles_extension{DiscardFramebuffer,EXT,discard_framebuffer} * on OpenGL ES 2.0 * @requires_gl43 %Extension @extension{ARB,invalidate_subdata}. Use - * @ref clear() instead where the extension is not supported. + * @ref Magnum::DefaultFramebuffer::clear() "clear()" instead + * where the extension is not supported. * @requires_gles30 %Extension @es_extension{EXT,discard_framebuffer}. - * Use @ref clear() instead where the extension is not supported. + * Use @ref Magnum::DefaultFramebuffer::clear() "clear()" instead + * where the extension is not supported. */ void invalidate(std::initializer_list attachments); @@ -409,9 +411,11 @@ class MAGNUM_EXPORT DefaultFramebuffer: public AbstractFramebuffer { * @see @fn_gl{InvalidateSubFramebuffer} or @fn_gles_extension{DiscardSubFramebuffer,EXT,discard_framebuffer} * on OpenGL ES 2.0 * @requires_gl43 %Extension @extension{ARB,invalidate_subdata}. Use - * @ref clear() instead where the extension is not supported. + * @ref Magnum::DefaultFramebuffer::clear() "clear()" instead + * where the extension is not supported. * @requires_gles30 %Extension @es_extension{EXT,discard_framebuffer}. - * Use @ref clear() instead where the extension is not supported. + * Use @ref Magnum::DefaultFramebuffer::clear() "clear()" instead + * where the extension is not supported. */ void invalidate(std::initializer_list attachments, const Range2Di& rectangle); diff --git a/src/Framebuffer.h b/src/Framebuffer.h index d9072fdf0..8e09d8601 100644 --- a/src/Framebuffer.h +++ b/src/Framebuffer.h @@ -107,7 +107,7 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje /** * @brief Color attachment * - * @see @ref Attachment, @ref attachRenderbuffer(), + * @see @ref BufferAttachment, @ref attachRenderbuffer(), * @ref attachTexture1D(), @ref attachTexture2D(), * @ref attachCubeMapTexture(), @ref attachTexture3D() */ @@ -176,7 +176,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * * @requires_gles30 Combined depth and stencil attachment is * not available in OpenGL ES 2.0. Attach the same object - * to both @ref Depth and @ref Stencil instead. + * to both @ref Magnum::Framebuffer::BufferAttachment::Depth + * "BufferAttachment::Depth" and @ref Magnum::Framebuffer::BufferAttachment::Stencil + * "BufferAttachment::Stencil" instead. * @todo Support this in ES2 (bind to both depth and stencil internally) */ static const BufferAttachment DepthStencil; @@ -438,9 +440,11 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * @see @fn_gl{InvalidateFramebuffer} or @fn_gles_extension{DiscardFramebuffer,EXT,discard_framebuffer} * on OpenGL ES 2.0 * @requires_gl43 %Extension @extension{ARB,invalidate_subdata}. Use - * @ref clear() instead where the extension is not supported. + * @ref Magnum::Framebuffer::clear() "clear()" instead where the + * extension is not supported. * @requires_gles30 %Extension @es_extension{EXT,discard_framebuffer}. - * Use @ref clear() instead where the extension is not supported. + * Use @ref Magnum::Framebuffer::clear() "clear()" instead where + * the extension is not supported. */ void invalidate(std::initializer_list attachments); @@ -454,9 +458,11 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * @see @fn_gl{InvalidateSubFramebuffer} or @fn_gles_extension{DiscardSubFramebuffer,EXT,discard_framebuffer} * on OpenGL ES 2.0 * @requires_gl43 %Extension @extension{ARB,invalidate_subdata}. Use - * @ref clear() instead where the extension is not supported. + * @ref Magnum::Framebuffer::clear() "clear()" instead where the + * extension is not supported. * @requires_gles30 %Extension @es_extension{EXT,discard_framebuffer}. - * Use @ref clear() instead where the extension is not supported. + * Use @ref Magnum::Framebuffer::clear() "clear()" instead where + * the extension is not supported. */ void invalidate(std::initializer_list attachments, const Range2Di& rectangle); diff --git a/src/Math/Matrix3.h b/src/Math/Matrix3.h index 60a64ddcd..380ba6ad6 100644 --- a/src/Math/Matrix3.h +++ b/src/Math/Matrix3.h @@ -129,7 +129,7 @@ template class Matrix3: public Matrix<3, T> { * constructor with `Matrix3 m(Matrix3::Identity);`. Optional parameter * @p value allows you to specify value on diagonal. */ - constexpr /*implicit*/ Matrix3(typename Matrix<3, T>::IdentityType identity = (Matrix<3, T>::Identity), T value = T(1)): Matrix<3, T>(identity, value) {} + constexpr /*implicit*/ Matrix3(typename Matrix<3, T>::IdentityType = (Matrix<3, T>::Identity), T value = T(1)): Matrix<3, T>(Matrix<3, T>::Identity, value) {} /** @brief %Matrix from column vectors */ constexpr /*implicit*/ Matrix3(const Vector3& first, const Vector3& second, const Vector3& third): Matrix<3, T>(first, second, third) {} @@ -206,7 +206,7 @@ template class Matrix3: public Matrix<3, T> { * to @ref uniformScaling(), because it doesn't compute the square * root. * @see @ref rotationScaling(), @ref rotation(), - * @ref rotationNormalized(), @ref scaling(const Vector2&), + * @ref rotationNormalized(), @ref scaling(const Vector2&), * @ref Matrix4::uniformScaling() */ T uniformScalingSquared() const { @@ -223,7 +223,7 @@ template class Matrix3: public Matrix<3, T> { * the scaling is the same in all axes. Use faster alternative * @ref uniformScalingSquared() where possible. * @see @ref rotationScaling(), @ref rotation(), - * @ref rotationNormalized(), @ref scaling(const Vector2&), + * @ref rotationNormalized(), @ref scaling(const Vector2&), * @ref Matrix4::uniformScaling() */ T uniformScaling() const { return std::sqrt(uniformScalingSquared()); } diff --git a/src/Math/Matrix4.h b/src/Math/Matrix4.h index e1270c132..702b506a8 100644 --- a/src/Math/Matrix4.h +++ b/src/Math/Matrix4.h @@ -191,7 +191,7 @@ template class Matrix4: public Matrix<4, T> { * constructor with `Matrix4 m(Matrix4::Identity);`. Optional parameter * @p value allows you to specify value on diagonal. */ - constexpr /*implicit*/ Matrix4(typename Matrix<4, T>::IdentityType = (Matrix<4, T>::Identity), T value = T(1)): Matrix<4, T>({}, value) {} + constexpr /*implicit*/ Matrix4(typename Matrix<4, T>::IdentityType = (Matrix<4, T>::Identity), T value = T(1)): Matrix<4, T>(Matrix<4, T>::Identity, value) {} /** @brief %Matrix from column vectors */ constexpr /*implicit*/ Matrix4(const Vector4& first, const Vector4& second, const Vector4& third, const Vector4& fourth): Matrix<4, T>(first, second, third, fourth) {} @@ -269,7 +269,7 @@ template class Matrix4: public Matrix<4, T> { * to @ref uniformScaling(), because it doesn't compute the square * root. * @see @ref rotationScaling(), @ref rotation(), - * @ref rotationNormalized(), @ref scaling(const Vector3&), + * @ref rotationNormalized(), @ref scaling(const Vector3&), * @ref Matrix3::uniformScaling() */ T uniformScalingSquared() const; @@ -281,7 +281,7 @@ template class Matrix4: public Matrix<4, T> { * the scaling is the same in all axes. Use faster alternative * @ref uniformScalingSquared() where possible. * @see @ref rotationScaling(), @ref rotation(), - * @ref rotationNormalized(), @ref scaling(const Vector3&), + * @ref rotationNormalized(), @ref scaling(const Vector3&), * @ref Matrix3::uniformScaling() */ T uniformScaling() const { return std::sqrt(uniformScalingSquared()); } diff --git a/src/Math/RectangularMatrix.h b/src/Math/RectangularMatrix.h index 8f1450364..21c17d60d 100644 --- a/src/Math/RectangularMatrix.h +++ b/src/Math/RectangularMatrix.h @@ -359,7 +359,11 @@ template class RectangularMatrix { return *reinterpret_cast*>(data()); } + #ifndef DOXYGEN_GENERATING_OUTPUT protected: + #else + private: + #endif /* Implementation for RectangularMatrix::fromDiagonal() and Matrix(T) */ template constexpr explicit RectangularMatrix(Implementation::Sequence, const Vector& diagonal); @@ -654,9 +658,11 @@ template inline RectangularMatrix inline constexpr auto RectangularMatrix::diagonal() const -> Vector { return diagonalInternal(typename Implementation::GenerateSequence::Type()); } +#ifndef DOXYGEN_GENERATING_OUTPUT template template inline constexpr auto RectangularMatrix::diagonalInternal(Implementation::Sequence) const -> Vector { return {(*this)[sequence][sequence]...}; } +#endif }} diff --git a/src/Math/Swizzle.h b/src/Math/Swizzle.h index 0a8606ffa..0575b2e91 100644 --- a/src/Math/Swizzle.h +++ b/src/Math/Swizzle.h @@ -77,7 +77,7 @@ four-component, corresponding @ref Math::Vector2, @ref Math::Vector3, @ref Math::Vector4, @ref Color3 or @ref Color4 specialization is returned. @see @ref matrix-vector-component-access, @ref Vector4::xyz(), - @ref Vector4::xy(), @ref Vector3::xy(), @ref Color4::rgb() + @ref Vector4::xy(), @ref Vector3::xy(), @ref BasicColor4::rgb() */ template constexpr typename Implementation::TypeForSize::Type swizzle(const T& vector) { return {Implementation::Component::value(vector)...}; diff --git a/src/Test/AbstractShaderProgramGLTest.cpp b/src/Test/AbstractShaderProgramGLTest.cpp index 775aebafd..0fd679c97 100644 --- a/src/Test/AbstractShaderProgramGLTest.cpp +++ b/src/Test/AbstractShaderProgramGLTest.cpp @@ -297,6 +297,7 @@ namespace { }; } +#ifndef DOXYGEN_GENERATING_OUTPUT MyShader::MyShader() { Utility::Resource rs("AbstractShaderProgramGLTest"); @@ -326,6 +327,7 @@ MyShader::MyShader() { colorUniform = uniformLocation("color"); additionsUniform = uniformLocation("additions"); } +#endif void AbstractShaderProgramGLTest::uniform() { MyShader shader; diff --git a/src/Test/MeshGLTest.cpp b/src/Test/MeshGLTest.cpp index 948c0f325..d23a69401 100644 --- a/src/Test/MeshGLTest.cpp +++ b/src/Test/MeshGLTest.cpp @@ -277,6 +277,7 @@ namespace { }; } +#ifndef DOXYGEN_GENERATING_OUTPUT FloatShader::FloatShader(const std::string& type, const std::string& conversion) { /* We need special version for ES3, because GLSL in ES2 doesn't support rectangle matrices */ @@ -403,6 +404,7 @@ template T Checker::get(ColorFormat format, ColorType type) { framebuffer.read({}, Vector2i(1), image); return image.data()[0]; } +#endif #ifndef MAGNUM_TARGET_GLES2 void MeshGLTest::addVertexBufferUnsignedInt() { @@ -982,6 +984,7 @@ namespace { }; } +#ifndef DOXYGEN_GENERATING_OUTPUT MultipleShader::MultipleShader() { #ifndef MAGNUM_TARGET_GLES Shader vert(Version::GL210, Shader::Type::Vertex); @@ -1017,6 +1020,7 @@ MultipleShader::MultipleShader() { CORRADE_INTERNAL_ASSERT_OUTPUT(link()); } +#endif void MeshGLTest::addVertexBufferMultiple() { const Float data[] = { @@ -1132,6 +1136,7 @@ namespace { constexpr Color4ub indexedResult(64 + 15 + 97, 17 + 164 + 28, 56 + 17, 255); } +#ifndef DOXYGEN_GENERATING_OUTPUT IndexChecker::IndexChecker(Mesh& mesh): framebuffer({{}, Vector2i(1)}) { #ifndef MAGNUM_TARGET_GLES2 renderbuffer.setStorage(RenderbufferFormat::RGBA8, Vector2i(1)); @@ -1156,6 +1161,7 @@ Color4ub IndexChecker::get() { framebuffer.read({}, Vector2i(1), image); return image.data()[0]; } +#endif void MeshGLTest::setIndexBuffer() { Buffer vertices; diff --git a/src/Test/SampleQueryGLTest.cpp b/src/Test/SampleQueryGLTest.cpp index d66bd6c39..3fae6a0f7 100644 --- a/src/Test/SampleQueryGLTest.cpp +++ b/src/Test/SampleQueryGLTest.cpp @@ -64,6 +64,7 @@ namespace { }; } +#ifndef DOXYGEN_GENERATING_OUTPUT MyShader::MyShader() { Utility::Resource rs("QueryGLTest"); #ifndef MAGNUM_TARGET_GLES @@ -86,6 +87,7 @@ MyShader::MyShader() { CORRADE_INTERNAL_ASSERT_OUTPUT(link()); } +#endif void SampleQueryGLTest::querySamplesPassed() { #ifdef MAGNUM_TARGET_GLES2