From f0cbb8d3c1b8f65112d67ada75ccd0a7cfb971d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 13 Nov 2022 16:53:54 +0100 Subject: [PATCH] Doc++ Forgot to run Doxygen after a475c92d99176f3721b83fa9d8060ef9a5bc6bda. --- doc/changelog.dox | 2 +- doc/opengl-mapping.dox | 2 +- src/Magnum/GL/AbstractShaderProgram.h | 4 ++-- src/Magnum/GL/MeshView.h | 8 ++++---- src/Magnum/Shaders/DistanceFieldVectorGL.h | 4 ++-- src/Magnum/Shaders/FlatGL.h | 4 ++-- src/Magnum/Shaders/MeshVisualizerGL.h | 8 ++++---- src/Magnum/Shaders/PhongGL.h | 4 ++-- src/Magnum/Shaders/VectorGL.h | 4 ++-- src/Magnum/Shaders/VertexColorGL.h | 4 ++-- src/Magnum/Trade/MaterialData.h | 8 ++++---- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/changelog.dox b/doc/changelog.dox index 561352224..c4e623a9c 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -123,7 +123,7 @@ See also: [mosra/magnum#576](https://github.com/mosra/magnum/pull/576)) - Recognizing ANGLE GLES and WebGL base vertex, base instance and multi-draw extensions and using them in @ref GL::AbstractShaderProgram::draw(Mesh&) - and @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>): + and @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&): - @gl_extension{EXT,draw_elements_base_vertex} - @gl_extension{OES,draw_elements_base_vertex} - @m_class{m-doc-external} [ANGLE_multi_draw](https://chromium.googlesource.com/angle/angle/+/master/extensions/ANGLE_multi_draw.txt) diff --git a/doc/opengl-mapping.dox b/doc/opengl-mapping.dox index 836f42450..c5cf38f5c 100644 --- a/doc/opengl-mapping.dox +++ b/doc/opengl-mapping.dox @@ -293,7 +293,7 @@ OpenGL function | Matching API @fn_gl_extension{MaxShaderCompilerThreads,KHR,parallel_shader_compile} | | @fn_gl{MemoryBarrier}, \n `glMemoryBarrierByRegion()` | @ref GL::Renderer::setMemoryBarrier(), \n @ref GL::Renderer::setMemoryBarrierByRegion() @fn_gl{MinSampleShading} | @ref GL::Renderer::setMinSampleShading() -@fn_gl{MultiDrawArrays}, \n @fn_gl{MultiDrawElements}, \n @fn_gl{MultiDrawElementsBaseVertex} | @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) +@fn_gl{MultiDrawArrays}, \n @fn_gl{MultiDrawElements}, \n @fn_gl{MultiDrawElementsBaseVertex} | @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) @fn_gl{MultiDrawArraysIndirectCount}, \n @fn_gl{MultiDrawElementsIndirectCount} | | @subsection opengl-mapping-functions-o O diff --git a/src/Magnum/GL/AbstractShaderProgram.h b/src/Magnum/GL/AbstractShaderProgram.h index 45bafc4d5..95b132b02 100644 --- a/src/Magnum/GL/AbstractShaderProgram.h +++ b/src/Magnum/GL/AbstractShaderProgram.h @@ -850,7 +850,7 @@ class MAGNUM_GL_EXPORT AbstractShaderProgram: public AbstractObject { * instead of setting up the mesh from scratch. * @see @ref Mesh::setCount(), @ref Mesh::setInstanceCount(), * @ref draw(MeshView&), - * @ref draw(Containers::ArrayView>), + * @ref draw(const Containers::Iterable&), * @ref drawTransformFeedback(), * @fn_gl_keyword{UseProgram}, @fn_gl_keyword{EnableVertexAttribArray}, * @fn_gl{BindBuffer}, @fn_gl_keyword{VertexAttribPointer}, @@ -895,7 +895,7 @@ class MAGNUM_GL_EXPORT AbstractShaderProgram: public AbstractObject { * @m_since{2020,06} * * See @ref draw(Mesh&) for more information. - * @see @ref draw(Containers::ArrayView>), + * @see @ref draw(const Containers::Iterable&), * @ref drawTransformFeedback() * @requires_gl32 Extension @gl_extension{ARB,draw_elements_base_vertex} * if the mesh is indexed and @ref MeshView::baseVertex() is not diff --git a/src/Magnum/GL/MeshView.h b/src/Magnum/GL/MeshView.h index f2560cd23..52f03246a 100644 --- a/src/Magnum/GL/MeshView.h +++ b/src/Magnum/GL/MeshView.h @@ -63,7 +63,7 @@ class MAGNUM_GL_EXPORT MeshView { /** * @brief Draw multiple meshes at once * @m_deprecated_since{2020,06} Use - * @ref AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref AbstractShaderProgram::draw(const Containers::Iterable&) * instead. */ CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram& shader, Containers::ArrayView> meshes); @@ -71,7 +71,7 @@ class MAGNUM_GL_EXPORT MeshView { /** * @overload * @m_deprecated_since{2020,06} Use - * @ref AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref AbstractShaderProgram::draw(const Containers::Iterable&) * instead. */ CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram&& shader, Containers::ArrayView> meshes); @@ -79,7 +79,7 @@ class MAGNUM_GL_EXPORT MeshView { /** * @overload * @m_deprecated_since{2020,06} Use - * @ref AbstractShaderProgram::draw(std::initializer_list>) + * @ref AbstractShaderProgram::draw(const Containers::Iterable&) * instead. */ CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram& shader, std::initializer_list> meshes); @@ -87,7 +87,7 @@ class MAGNUM_GL_EXPORT MeshView { /** * @overload * @m_deprecated_since{2020,06} Use - * @ref AbstractShaderProgram::draw(std::initializer_list>) + * @ref AbstractShaderProgram::draw(const Containers::Iterable&) * instead. */ CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram&& shader, std::initializer_list> meshes); diff --git a/src/Magnum/Shaders/DistanceFieldVectorGL.h b/src/Magnum/Shaders/DistanceFieldVectorGL.h index 8531db0fe..a959dd92d 100644 --- a/src/Magnum/Shaders/DistanceFieldVectorGL.h +++ b/src/Magnum/Shaders/DistanceFieldVectorGL.h @@ -184,7 +184,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and adds the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -498,7 +498,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Shaders/FlatGL.h b/src/Magnum/Shaders/FlatGL.h index 74c58f365..8746f4393 100644 --- a/src/Magnum/Shaders/FlatGL.h +++ b/src/Magnum/Shaders/FlatGL.h @@ -490,7 +490,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and adds the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -841,7 +841,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Shaders/MeshVisualizerGL.h b/src/Magnum/Shaders/MeshVisualizerGL.h index 8ad728b5e..ff253a6f3 100644 --- a/src/Magnum/Shaders/MeshVisualizerGL.h +++ b/src/Magnum/Shaders/MeshVisualizerGL.h @@ -410,7 +410,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and combines the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -753,7 +753,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. @@ -1603,7 +1603,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and combines the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -2160,7 +2160,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Shaders/PhongGL.h b/src/Magnum/Shaders/PhongGL.h index 7ecf92d0c..3ad3f0ce1 100644 --- a/src/Magnum/Shaders/PhongGL.h +++ b/src/Magnum/Shaders/PhongGL.h @@ -679,7 +679,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and adds the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -1409,7 +1409,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Shaders/VectorGL.h b/src/Magnum/Shaders/VectorGL.h index 67ec1930f..1a64d2f92 100644 --- a/src/Magnum/Shaders/VectorGL.h +++ b/src/Magnum/Shaders/VectorGL.h @@ -179,7 +179,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and adds the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -454,7 +454,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Shaders/VertexColorGL.h b/src/Magnum/Shaders/VertexColorGL.h index a6378796e..e97108502 100644 --- a/src/Magnum/Shaders/VertexColorGL.h +++ b/src/Magnum/Shaders/VertexColorGL.h @@ -174,7 +174,7 @@ template class MAGNUM_SHADERS_EXPORT VertexColorGL: publ * Enable multidraw functionality. Implies @ref Flag::UniformBuffers * and adds the value from @ref setDrawOffset() with the * @glsl gl_DrawID @ce builtin, which makes draws submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up per-draw parameters directly, without having to rebind * the uniform buffers or specify @ref setDrawOffset() before each * draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is @@ -384,7 +384,7 @@ template class MAGNUM_SHADERS_EXPORT VertexColorGL: publ * * If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this * value, which makes each draw submitted via - * @ref GL::AbstractShaderProgram::draw(Containers::ArrayView>) + * @ref GL::AbstractShaderProgram::draw(const Containers::Iterable&) * pick up its own per-draw parameters. * @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object} * @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0. diff --git a/src/Magnum/Trade/MaterialData.h b/src/Magnum/Trade/MaterialData.h index d93888bec..8c9a54b57 100644 --- a/src/Magnum/Trade/MaterialData.h +++ b/src/Magnum/Trade/MaterialData.h @@ -2242,10 +2242,10 @@ class MAGNUM_TRADE_EXPORT MaterialData { * @brief Offset of a layer inside attribute data * * Returns the offset where attributes for @p layer start in the array - * returned by @ref atttributeData() const. The @p layer is expected - * to be less *or equal to* @ref layerCount(), i.e. it's always - * possible to call this function with @cpp layer @ce and - * @cpp layer + 1 @ce to get the attribute range for given layer. + * returned by @ref attributeData() const. The @p layer is expected to + * be less *or equal to* @ref layerCount(), i.e. it's always possible + * to call this function with @cpp layer @ce and @cpp layer + 1 @ce to + * get the attribute range for given layer. */ UnsignedInt attributeDataOffset(UnsignedInt layer) const;