From 8131701e7ef4a33f4e84b300111f1fe91f5ac011 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 27 Jul 2019 00:28:53 +0200 Subject: [PATCH] Doc++, updated credits and changelog. --- doc/changelog.dox | 2 ++ doc/credits.dox | 2 ++ src/Magnum/GL/AbstractFramebuffer.h | 2 +- src/Magnum/GL/Texture.h | 8 ++++---- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/changelog.dox b/doc/changelog.dox index c669b3154..a7be400a9 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -459,6 +459,8 @@ See also: [mosra/magnum#211](https://github.com/mosra/magnum/issues/211)) - Fixed Gentoo build instructions (see [mosra/magnum#344](https://github.com/mosra/magnum/pull/344)) +- Various documentation improvements and copy editing (see + [mosra/magnum#361](https://github.com/mosra/magnum/pull/361)) @subsection changelog-latest-deprecated Deprecated APIs diff --git a/doc/credits.dox b/doc/credits.dox index 61f1e04ce..969801c8c 100644 --- a/doc/credits.dox +++ b/doc/credits.dox @@ -146,6 +146,8 @@ Are the below lists missing your name or something's wrong? --- initial macOS port, various other improvements - **Nathan Ollerenshaw** ([\@matjam](https://github.com/matjam)) --- Ubuntu packages in a PPA repository +- **Nick Skelsey** ([\@NSkelsey](https://github.com/NSkelsey)) --- + documentation copy-editing - **Nicholas "LB" Branden** ([\@LB--](https://github.com/LB--)) --- warning fixes, Windows buildsystem improvements - **Olga Turanksaya** ([\@olga-python](https://github.com/olga-python)) --- diff --git a/src/Magnum/GL/AbstractFramebuffer.h b/src/Magnum/GL/AbstractFramebuffer.h index f894670a8..885d1fe43 100644 --- a/src/Magnum/GL/AbstractFramebuffer.h +++ b/src/Magnum/GL/AbstractFramebuffer.h @@ -382,7 +382,7 @@ class MAGNUM_GL_EXPORT AbstractFramebuffer { * given image. The storage is not reallocated if it is large enough to * contain the new data --- however if you want to read into existing * memory or *ensure* a reallocation does not happen, use - * @ref read(const Range2Di&, MutableImageView2D&) instead. + * @ref read(const Range2Di&, const MutableImageView2D&) instead. * * On OpenGL ES 2.0 and WebGL 1.0, if @ref PixelStorage::skip() is set, * the functionality is emulated by adjusting the data pointer. If diff --git a/src/Magnum/GL/Texture.h b/src/Magnum/GL/Texture.h index c62da3ffa..20663ddcc 100644 --- a/src/Magnum/GL/Texture.h +++ b/src/Magnum/GL/Texture.h @@ -757,7 +757,7 @@ template class Texture: public AbstractTexture { * @ref imageSize(). The storage is not reallocated if it is large * enough to contain the new data --- however if you want to read into * existing memory or *ensure* a reallocation does not happen, use - * @ref image(Int, BasicMutableImageView&) instead. + * @ref image(Int, const BasicMutableImageView&) instead. * * If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is * not available, the texture is bound before the operation (if not @@ -834,7 +834,7 @@ template class Texture: public AbstractTexture { * size is taken using @ref imageSize(). The storage is not reallocated * if it is large enough to contain the new data --- however if you * want to read into existing memory or *ensure* a reallocation does - * not happen, use @ref compressedImage(Int, BasicMutableCompressedImageView&) + * not happen, use @ref compressedImage(Int, const BasicMutableCompressedImageView&) * instead. * * If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is @@ -920,7 +920,7 @@ template class Texture: public AbstractTexture { * given image. The storage is not reallocated if it is large enough to * contain the new data --- however if you want to read into existing * memory or *ensure* a reallocation does not happen, use - * @ref subImage(Int, const RangeTypeFor&, BasicMutableImageView&) + * @ref subImage(Int, const RangeTypeFor&, const BasicMutableImageView&) * instead. * * The operation is protected from buffer overflow. @@ -990,7 +990,7 @@ template class Texture: public AbstractTexture { * storage is not reallocated if it is large enough to contain the new * data --- however if you want to read into existing memory or * *ensure* a reallocation does not happen, use - * @ref compressedSubImage(Int, const RangeTypeFor&, BasicMutableCompressedImageView&) + * @ref compressedSubImage(Int, const RangeTypeFor&, const BasicMutableCompressedImageView&) * instead. * @see @fn_gl2{GetTextureLevelParameter,GetTexLevelParameter}, * eventually @fn_gl{GetTexLevelParameter} with