diff --git a/Doxyfile b/Doxyfile index 7e9af6368..4654c9f5f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -209,6 +209,7 @@ ALIASES = \ "collisionoperator{2}=@relates \1\n@brief %Collision of %\1 and %\2\n@see \2::operator/(const \1&) const" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "fn_gl{1}=gl\1()" \ + "fn_gl2{2}=gl\1()" \ "fn_gl_extension{3}=gl\1\2()" \ "fn_gl_extension2{3}=gl\1\2()" \ "fn_gles_extension{3}=gl\1\2()" \ diff --git a/src/Magnum/AbstractShaderProgram.h b/src/Magnum/AbstractShaderProgram.h index 8b89c42ef..a991a01e9 100644 --- a/src/Magnum/AbstractShaderProgram.h +++ b/src/Magnum/AbstractShaderProgram.h @@ -589,7 +589,7 @@ class MAGNUM_EXPORT AbstractShaderProgram: public AbstractObject { /** * @brief Attach shader * - * @fn_gl{AttachShader} + * @see @fn_gl{AttachShader} */ void attachShader(Shader& shader); diff --git a/src/Magnum/AbstractTexture.h b/src/Magnum/AbstractTexture.h index 251c99f87..224add195 100644 --- a/src/Magnum/AbstractTexture.h +++ b/src/Magnum/AbstractTexture.h @@ -95,6 +95,7 @@ nothing. @todo `GL_MAX_TEXTURE_LOD_BIAS` when `TEXTURE_LOD_BIAS` is implemented @todo `GL_NUM_COMPRESSED_TEXTURE_FORMATS` when compressed textures are implemented @todo `GL_MAX_SAMPLE_MASK_WORDS` when @extension{ARB,texture_multisample} is done +@todo Query for immutable levels (@extension{ARB,ES3_compatibility}) */ class MAGNUM_EXPORT AbstractTexture: public AbstractObject { friend class Context; @@ -293,7 +294,7 @@ class MAGNUM_EXPORT AbstractTexture: public AbstractObject { * @param level Mip level * * If running on OpenGL ES or extension @extension{ARB,invalidate_subdata} - * is not available, this function does nothing. + * (part of OpenGL 4.3) is not available, this function does nothing. * @see @ref Texture::invalidateSubImage() "invalidateSubImage()", * @fn_gl{InvalidateTexImage} */ diff --git a/src/Magnum/Buffer.h b/src/Magnum/Buffer.h index e3e975ae7..b753658c3 100644 --- a/src/Magnum/Buffer.h +++ b/src/Magnum/Buffer.h @@ -741,7 +741,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @return Reference to self (for method chaining) * * If running on OpenGL ES or extension @extension{ARB,invalidate_subdata} - * is not available, this function does nothing. + * (part of OpenGL 4.3) is not available, this function does nothing. * @see @ref MapFlag::InvalidateBuffer, @fn_gl{InvalidateBufferData} */ Buffer& invalidateData() { @@ -756,7 +756,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @return Reference to self (for method chaining) * * If running on OpenGL ES or extension @extension{ARB,invalidate_subdata} - * is not available, this function does nothing. + * (part of OpenGL 4.3) is not available, this function does nothing. * @see @ref MapFlag::InvalidateRange, @fn_gl{InvalidateBufferData} */ Buffer& invalidateSubData(GLintptr offset, GLsizeiptr length) { diff --git a/src/Magnum/DebugMessage.h b/src/Magnum/DebugMessage.h index f87de89c7..9be705f51 100644 --- a/src/Magnum/DebugMessage.h +++ b/src/Magnum/DebugMessage.h @@ -281,7 +281,8 @@ class MAGNUM_EXPORT DebugMessage { * supported and @extension{KHR,debug} is not available, this function * does nothing. * @see @ref setDefaultCallback(), - * @ref Renderer::Feature::DebugOutputSynchronous + * @ref Renderer::Feature::DebugOutputSynchronous, + * @fn_gl{DebugMessageCallback} */ static void setCallback(Callback callback, const void* userParam = nullptr); @@ -296,8 +297,8 @@ class MAGNUM_EXPORT DebugMessage { * DebugMessage::Type::Marker, 1337, DebugMessage::Severity::Notification, "Hello from OpenGL command stream!"); * @endcode * - *
%DebugMessage::Source::Application %DebugMessage::Type::Marker -1 %DebugMessage::Severity::Notification
-         *     Hello from OpenGL command stream!
+ * > %DebugMessage::Source::Application %DebugMessage::Type::Marker -1 %DebugMessage::Severity::Notification\n + * >     Hello from OpenGL command stream! */ static void setDefaultCallback(); diff --git a/src/Magnum/Framebuffer.h b/src/Magnum/Framebuffer.h index fd8b9617b..a1ac6b7a7 100644 --- a/src/Magnum/Framebuffer.h +++ b/src/Magnum/Framebuffer.h @@ -276,10 +276,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje #endif #ifndef MAGNUM_TARGET_GLES - /** @todo Why exactly this is not needed? */ /** * Mismatched layered color attachments - * @requires_gl Not available in OpenGL ES. + * @requires_gl Geometry shaders are not available in OpenGL ES. */ IncompleteLayerTargets = GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS #endif @@ -494,8 +493,8 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * If @extension{EXT,direct_state_access} is not available and the * framebufferbuffer is not currently bound, it is bound before the * operation. - * @see @fn_gl{BindFramebuffer}, @fn_gl{FramebufferTexture} or - * @fn_gl_extension{NamedFramebufferTexture1D,EXT,direct_state_access} + * @see @fn_gl{BindFramebuffer}, @fn_gl2{FramebufferTexture1D,FramebufferTexture} + * or @fn_gl_extension{NamedFramebufferTexture1D,EXT,direct_state_access} * @requires_gl Only 2D and 3D textures are available in OpenGL ES. */ Framebuffer& attachTexture1D(BufferAttachment attachment, Texture1D& texture, Int level) { @@ -514,8 +513,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * If @extension{EXT,direct_state_access} is not available and the * framebufferbuffer is not currently bound, it is bound before the * operation. - * @see @ref attachCubeMapTexture(), @fn_gl{BindFramebuffer}, @fn_gl{FramebufferTexture} - * or @fn_gl_extension{NamedFramebufferTexture2D,EXT,direct_state_access} + * @see @ref attachCubeMapTexture(), @fn_gl{BindFramebuffer}, + * @fn_gl2{FramebufferTexture2D,FramebufferTexture} or + * @fn_gl_extension{NamedFramebufferTexture2D,EXT,direct_state_access} */ Framebuffer& attachTexture2D(BufferAttachment attachment, Texture2D& texture, Int level); @@ -530,8 +530,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * If @extension{EXT,direct_state_access} is not available and the * framebufferbuffer is not currently bound, it is bound before the * operation. - * @see @ref attachTexture2D(), @fn_gl{BindFramebuffer}, @fn_gl{FramebufferTexture} - * or @fn_gl_extension{NamedFramebufferTexture2D,EXT,direct_state_access} + * @see @ref attachTexture2D(), @fn_gl{BindFramebuffer}, + * @fn_gl2{FramebufferTexture2D,FramebufferTexture} or + * @fn_gl_extension{NamedFramebufferTexture2D,EXT,direct_state_access} */ Framebuffer& attachCubeMapTexture(BufferAttachment attachment, CubeMapTexture& texture, CubeMapTexture::Coordinate coordinate, Int level) { (this->*texture2DImplementation)(attachment, GLenum(coordinate), texture.id(), level); @@ -549,8 +550,8 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * If @extension{EXT,direct_state_access} is not available and the * framebufferbuffer is not currently bound, it is bound before the * operation. - * @see @fn_gl{BindFramebuffer}, @fn_gl{FramebufferTexture} or - * @fn_gl_extension{NamedFramebufferTexture3D,EXT,direct_state_access} + * @see @fn_gl{BindFramebuffer}, @fn_gl2{FramebufferTexture3D,FramebufferTexture} + * or @fn_gl_extension{NamedFramebufferTexture3D,EXT,direct_state_access} * @requires_es_extension %Extension @es_extension{OES,texture_3D} */ Framebuffer& attachTexture3D(BufferAttachment attachment, Texture3D& texture, Int level, Int layer) { diff --git a/src/Magnum/Mesh.h b/src/Magnum/Mesh.h index cde708263..374553682 100644 --- a/src/Magnum/Mesh.h +++ b/src/Magnum/Mesh.h @@ -63,12 +63,14 @@ enum class MeshPrimitive: GLenum { /** * Line strip with adjacency information. * @requires_gl32 %Extension @extension{ARB,geometry_shader4} + * @requires_gl Geometry shaders are not available in OpenGL ES. */ LineStripAdjacency = GL_LINE_STRIP_ADJACENCY, /** * Lines with adjacency information. * @requires_gl32 %Extension @extension{ARB,geometry_shader4} + * @requires_gl Geometry shaders are not available in OpenGL ES. */ LinesAdjacency = GL_LINES_ADJACENCY, #endif @@ -92,18 +94,21 @@ enum class MeshPrimitive: GLenum { /** * Triangle strip with adjacency information. * @requires_gl32 %Extension @extension{ARB,geometry_shader4} + * @requires_gl Geometry shaders are not available in OpenGL ES. */ TriangleStripAdjacency = GL_TRIANGLE_STRIP_ADJACENCY, /** * Triangles with adjacency information. * @requires_gl32 %Extension @extension{ARB,geometry_shader4} + * @requires_gl Geometry shaders are not available in OpenGL ES. */ TrianglesAdjacency = GL_TRIANGLES_ADJACENCY, /** * Patches. * @requires_gl40 %Extension @extension{ARB,tessellation_shader} + * @requires_gl Tessellation shaders are not available in OpenGL ES. */ Patches = GL_PATCHES #endif diff --git a/src/Magnum/Query.h b/src/Magnum/Query.h index 3f0000610..5f5ac4d2b 100644 --- a/src/Magnum/Query.h +++ b/src/Magnum/Query.h @@ -41,6 +41,7 @@ namespace Magnum { See @ref PrimitiveQuery, @ref SampleQuery and @ref TimeQuery documentation for more information. @todo Support for AMD's query buffer (@extension{AMD,query_buffer_object}) +@todo `QUERY_COUNTER_BITS` (not sure since when this is supported) */ class MAGNUM_EXPORT AbstractQuery: public AbstractObject { public: diff --git a/src/Magnum/Texture.h b/src/Magnum/Texture.h index e5d70e745..dc4794b72 100644 --- a/src/Magnum/Texture.h +++ b/src/Magnum/Texture.h @@ -426,7 +426,7 @@ template class Texture: public AbstractTexture { * @param size Size of invalidated data * * If running on OpenGL ES or extension @extension{ARB,invalidate_subdata} - * is not available, this function does nothing. + * (part of OpenGL 4.3) is not available, this function does nothing. * @see @ref invalidateImage(), @fn_gl{InvalidateTexSubImage} */ void invalidateSubImage(Int level, const typename DimensionTraits::VectorType& offset, const typename DimensionTraits::VectorType& size) {