ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: fix mismatched enum value links. 

Doxygen 1.8.17 *finally* fixes enum value linking and so linking to
Enum::Value via TotallyArbitraryString::Value no longer works. That
uncovered a ton of documentation errors.

A welcome improvement, for once.
pull/415/head
Vladimír Vondruš 6 years ago
parent
d6718aaa1d
commit
9ae20a0a67
4 changed files with 39 additions and 43 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      src/Magnum/GL/CubeMapTexture.h
  2. 32
      src/Magnum/GL/Sampler.h
  3. 40
      src/Magnum/GL/TextureFormat.h
  4. 4
      src/Magnum/Trade/AnimationData.h

6
src/Magnum/GL/CubeMapTexture.h
Unescape View File

@ -529,7 +529,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture {
*
* If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is not
* available, it is assumed that faces have the same size and just the
* size of @ref Coordinate::PositiveX face is queried. See
* size of @ref CubeMapCoordinate::PositiveX face is queried. See
* @ref Texture::imageSize() for more information.
* @requires_gles31 Texture image size queries are not available in
* OpenGL ES 3.0 and older.
@ -1179,8 +1179,8 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture {
* @brief @copybrief Texture::invalidateSubImage()
*
* Z coordinate is equivalent to number of texture face, i.e.
* @ref Coordinate::PositiveX is `0` and so on, in the same order as in
* the enum.
* @ref CubeMapCoordinate::PositiveX is `0` and so on, in the same
* order as in the enum.
*
* See @ref Texture::invalidateSubImage() for more information.
*/

32
src/Magnum/GL/Sampler.h
Unescape View File

@ -51,17 +51,15 @@ enum class SamplerFilter: GLint {
* Linear interpolation filtering. Can't be used with integer
* texture formats.
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::Float
* for linear interpolation of textures with float @ref TextureFormat
* @requires_webgl_extension Extensiion @webgl_extension{OES,texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::Float
* for linear interpolation of textures with float @ref TextureFormat
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::HalfFloat in OpenGL ES 2.0.
* for linear interpolation of textures with half-float
* @ref TextureFormat in OpenGL ES 2.0.
* @requires_webgl20 Extension @webgl_extension{OES,texture_half_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::HalfFloat in WebGL 1.0.
* for linear interpolation of textures with half-float
* @ref TextureFormat in WebGL 1.0.
*/
Linear = GL_LINEAR
};
@ -100,17 +98,15 @@ enum class SamplerMipmap: GLint {
* rectangle textures.**
* @m_keywords{GL_NEAREST_MIPMAP_LINEAR GL_LINEAR_MIPMAP_LINEAR}
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::Float
* for linear interpolation of textures with float @ref TextureFormat
* @requires_webgl_extension Extensiion @webgl_extension{OES,texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::Float
* for linear interpolation of textures with float @ref TextureFormat
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::HalfFloat in OpenGL ES 2.0.
* for linear interpolation of textures with half-float
* @ref TextureFormat in OpenGL ES 2.0.
* @requires_webgl20 Extension @webgl_extension{OES,texture_half_float_linear}
* for linear interpolation of textures with
* @ref TextureFormat::HalfFloat in WebGL 1.0.
* for linear interpolation of textures with half-float
* @ref TextureFormat in WebGL 1.0.
*/
Linear = GL_NEAREST_MIPMAP_LINEAR & ~GL_NEAREST
};
@ -170,8 +166,8 @@ enum class SamplerWrapping: GLint {
* edge after that. **Unavailable on rectangle textures.**
* @requires_gl44 Extension @gl_extension{ARB,texture_mirror_clamp_to_edge},
* @gl_extension{ATI,texture_mirror_once} or @gl_extension{EXT,texture_mirror_clamp}
* @requires_gl Only separate @ref Wrapping::MirroredRepeat or
* @ref Wrapping::ClampToEdge is available in OpenGL ES and
* @requires_gl Only separate @ref SamplerWrapping::MirroredRepeat or
* @ref SamplerWrapping::ClampToEdge is available in OpenGL ES and
* WebGL.
*/
MirrorClampToEdge = GL_MIRROR_CLAMP_TO_EDGE

40
src/Magnum/GL/TextureFormat.h
Unescape View File

@ -665,7 +665,7 @@ enum class TextureFormat: GLenum {
* @see @ref Half, @ref Math::packHalf(), @ref Math::unpackHalf()
* @requires_gl30 Extension @gl_extension{ARB,texture_rg} and @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::Red / @ref TextureFormat::Luminance
* in combination with @ref PixelFormat::HalfFloat
* in combination with @ref PixelType::HalfFloat
* (@gl_extension2{OES,texture_half_float,OES_texture_float}) in OpenGL
* ES 2.0 instead.
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
@ -674,7 +674,7 @@ enum class TextureFormat: GLenum {
* use as a render target. Use @ref TextureFormat::R16UI or
* @ref TextureFormat::R16I instead if not available.
* @requires_webgl20 Use @ref TextureFormat::Red / @ref TextureFormat::Luminance
* in combination with @ref PixelFormat::HalfFloat (@webgl_extension{OES,texture_half_float})
* in combination with @ref PixelType::HalfFloat (@webgl_extension{OES,texture_half_float})
* in WebGL 1.0.
* @requires_webgl20 Extension @webgl_extension{OES,texture_half_float_linear}
* for filtering using @ref SamplerFilter::Linear in WebGL 1.0.
@ -692,7 +692,7 @@ enum class TextureFormat: GLenum {
* @see @ref Half, @ref Math::packHalf(), @ref Math::unpackHalf()
* @requires_gl30 Extension @gl_extension{ARB,texture_rg} and @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RG / @ref TextureFormat::LuminanceAlpha
* in combination with @ref PixelFormat::HalfFloat
* in combination with @ref PixelType::HalfFloat
* (@gl_extension2{OES,texture_half_float,OES_texture_float}) in OpenGL
* ES 2.0 instead.
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
@ -701,7 +701,7 @@ enum class TextureFormat: GLenum {
* use as a render target in OpenGL ES. Use @ref TextureFormat::RG16UI
* or @ref TextureFormat::RG16I instead if not available.
* @requires_webgl20 Use @ref TextureFormat::RG / @ref TextureFormat::LuminanceAlpha
* in combination with @ref PixelFormat::HalfFloat (@webgl_extension{OES,texture_half_float})
* in combination with @ref PixelType::HalfFloat (@webgl_extension{OES,texture_half_float})
* in WebGL 1.0 instead.
* @requires_webgl20 Extension @webgl_extension{OES,texture_half_float_linear}
* for filtering using @ref SamplerFilter::Linear in WebGL 1.0.
@ -719,16 +719,16 @@ enum class TextureFormat: GLenum {
* @see @ref Half, @ref Math::packHalf(), @ref Math::unpackHalf()
* @requires_gl30 Extension @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RGB in combination with
* @ref PixelFormat::HalfFloat (@gl_extension2{OES,texture_half_float,OES_texture_float})
* @ref PixelType::HalfFloat (@gl_extension2{OES,texture_half_float,OES_texture_float})
* in OpenGL ES 2.0 instead.
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
* for filtering using @ref SamplerFilter::Linear in OpenGL ES 2.0.
* @requires_webgl20 Use @ref TextureFormat::RGB in combination with
* @ref PixelFormat::HalfFloat (@webgl_extension{OES,texture_half_float})
* @ref PixelType::HalfFloat (@webgl_extension{OES,texture_half_float})
* in WebGL 1.0 instead.
* @requires_gl Can't be used as a render target in OpenGL ES or WebGL 2.0.
* Use @ref TextureFormat::RGBA16F instead. Use @ref TextureFormat::RGB
* in combination with @ref PixelFormat::HalfFloat
* in combination with @ref PixelType::HalfFloat
* (@webgl_extension{EXT,color_buffer_half_float}) in WebGL 1.0
* instead.
*/
@ -739,7 +739,7 @@ enum class TextureFormat: GLenum {
* @see @ref Half, @ref Math::packHalf(), @ref Math::unpackHalf()
* @requires_gl30 Extension @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RGBA in combination with
* @ref PixelFormat::HalfFloat (@gl_extension2{OES,texture_half_float,OES_texture_float})
* @ref PixelType::HalfFloat (@gl_extension2{OES,texture_half_float,OES_texture_float})
* in OpenGL ES 2.0 instead.
* @requires_gles30 Extension @gl_extension2{OES,texture_half_float_linear,OES_texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
@ -747,12 +747,12 @@ enum class TextureFormat: GLenum {
* use as a render target in OpenGL ES. Use @ref TextureFormat::RGBA16UI
* or @ref TextureFormat::RGBA16I instead if not available.
* @requires_webgl20 Use @ref TextureFormat::RGBA in combination with
* @ref PixelFormat::HalfFloat (@webgl_extension{OES,texture_half_float})
* @ref PixelType::HalfFloat (@webgl_extension{OES,texture_half_float})
* in WebGL 1.0 instead.
* @requires_webgl_extension Extension @webgl_extension{EXT,color_buffer_float}
* to use as a render target in WebGL 2.0. Use @ref TextureFormat::RGBA16UI
* or @ref TextureFormat::RGBA16I instead if not available. Use
* @ref TextureFormat::RGBA in combination with @ref PixelFormat::HalfFloat
* @ref TextureFormat::RGBA in combination with @ref PixelType::HalfFloat
* (@webgl_extension{EXT,color_buffer_half_float}) in WebGL 1.0 instead.
*/
RGBA16F = GL_RGBA16F,
@ -761,7 +761,7 @@ enum class TextureFormat: GLenum {
* Red component, float.
* @requires_gl30 Extension @gl_extension{ARB,texture_rg} and @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::Red / @ref TextureFormat::Luminance
* in combination with @ref PixelFormat::Float (@gl_extension{OES,texture_float})
* in combination with @ref PixelType::Float (@gl_extension{OES,texture_float})
* in OpenGL ES 2.0 instead.
* @requires_gles32 Extension @gl_extension{EXT,color_buffer_float} to use as
* a render target. Use @ref TextureFormat::R32UI or
@ -769,7 +769,7 @@ enum class TextureFormat: GLenum {
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
* @requires_webgl20 Use @ref TextureFormat::Red / @ref TextureFormat::Luminance
* in combination with @ref PixelFormat::Float (@webgl_extension{OES,texture_float})
* in combination with @ref PixelType::Float (@webgl_extension{OES,texture_float})
* in WebGL 1.0 instead.
* @requires_webgl_extension Extension @webgl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
@ -786,7 +786,7 @@ enum class TextureFormat: GLenum {
* Red and green component, each float.
* @requires_gl30 Extension @gl_extension{ARB,texture_rg} and @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RG / @ref TextureFormat::LuminanceAlpha
* in combination with @ref PixelFormat::Float (@gl_extension{OES,texture_float})
* in combination with @ref PixelType::Float (@gl_extension{OES,texture_float})
* in OpenGL ES 2.0 instead.
* @requires_gles32 Extension @gl_extension{EXT,color_buffer_float} to use as
* a render target. Use @ref TextureFormat::RG32UI or
@ -794,7 +794,7 @@ enum class TextureFormat: GLenum {
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
* @requires_webgl20 Use @ref TextureFormat::RG / @ref TextureFormat::LuminanceAlpha
* in combination with @ref PixelFormat::Float (@webgl_extension{OES,texture_float})
* in combination with @ref PixelType::Float (@webgl_extension{OES,texture_float})
* in WebGL 1.0 instead.
* @requires_webgl_extension Extension @webgl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
@ -811,18 +811,18 @@ enum class TextureFormat: GLenum {
* RGB, each component float.
* @requires_gl30 Extension @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RGB in combination with
* @ref PixelFormat::Float (@gl_extension{OES,texture_float}) in OpenGL
* @ref PixelType::Float (@gl_extension{OES,texture_float}) in OpenGL
* ES 2.0 instead.
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
* @requires_webgl20 Use @ref TextureFormat::RGB in combination with
* @ref PixelFormat::Float (@webgl_extension{OES,texture_float}) in
* @ref PixelType::Float (@webgl_extension{OES,texture_float}) in
* WebGL 1.0 instead.
* @requires_webgl_extension Extension @webgl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
* @requires_gl Can't be used as a render target in OpenGL ES or WebGL 2.0.
* Use @ref TextureFormat::RGBA32F instead. Use @ref TextureFormat::RGB
* in combination with @ref PixelFormat::Float
* in combination with @ref PixelType::Float
* (@webgl_extension{WEBGL,color_buffer_float}) in WebGL 1.0 instead.
*/
RGB32F = GL_RGB32F,
@ -831,7 +831,7 @@ enum class TextureFormat: GLenum {
* RGBA, each component float.
* @requires_gl30 Extension @gl_extension{ARB,texture_float}
* @requires_gles30 Use @ref TextureFormat::RGBA in combination with
* @ref PixelFormat::Float (@gl_extension{OES,texture_float}) in OpenGL
* @ref PixelType::Float (@gl_extension{OES,texture_float}) in OpenGL
* ES 2.0 instead.
* @requires_es_extension Extension @gl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
@ -839,14 +839,14 @@ enum class TextureFormat: GLenum {
* use as a render target in OpenGL ES. Use @ref TextureFormat::RGBA32UI
* or @ref TextureFormat::RGBA32I instead if not available.
* @requires_webgl20 Use @ref TextureFormat::RGBA in combination with
* @ref PixelFormat::Float (@webgl_extension{OES,texture_float}) in
* @ref PixelType::Float (@webgl_extension{OES,texture_float}) in
* WebGL 1.0 instead.
* @requires_webgl_extension Extension @webgl_extension{OES,texture_float_linear}
* for filtering using @ref SamplerFilter::Linear.
* @requires_webgl_extension Extension @webgl_extension{EXT,color_buffer_float}
* to use as a render target in WebGL 2.0. Use @ref TextureFormat::RGBA32UI
* or @ref TextureFormat::RGBA32I instead if not available. Use
* @ref TextureFormat::RGBA in combination with @ref PixelFormat::Float
* @ref TextureFormat::RGBA in combination with @ref PixelType::Float
* (@webgl_extension{WEBGL,color_buffer_float}) in WebGL 1.0 instead.
*/
RGBA32F = GL_RGBA32F,

4
src/Magnum/Trade/AnimationData.h
Unescape View File

@ -64,8 +64,8 @@ enum class AnimationTrackType: UnsignedByte {
/**
* @ref Magnum::Vector3 "Vector3". Usually used for
* @ref AnimationTrackTarget::Translation3D and
* @ref AnimationTrackTarget::Scaling3D.
* @ref AnimationTrackTargetType::Translation3D and
* @ref AnimationTrackTargetType::Scaling3D.
*/
Vector3,

Write Preview
Loading…
Cancel
Save