From 82a5a6772723688cc3931acc7cf7a71ea93d891c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 4 May 2018 21:20:49 +0200 Subject: [PATCH] doc: mention forgotten GL-related Doxygen commands. --- doc/coding-style.dox | 24 ++++++++++++++++++------ doc/snippets/coding-style.h | 4 ++++ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/doc/coding-style.dox b/doc/coding-style.dox index e6d7c4841..739c620d0 100644 --- a/doc/coding-style.dox +++ b/doc/coding-style.dox @@ -137,6 +137,16 @@ produces this link: @gl_extension2{NV,read_buffer_front,GL_NV_read_buffer} +WebGL extensions can be specified using @c \@webgl_extension. For example + +@snippet coding-style.h webgl_extension + +produces this: + +
+@webgl_extension{EXT,color_buffer_float} +
+ OpenAL extensions can be referenced using @c \@al_extension, OpenAL context extension using @c \@alc_extension. For example @@ -222,12 +232,14 @@ for some functionality (not related to any member function), it should be noted in the description. Similarly for OpenGL ES there is command @c \@requires_gl for functionality -not available in OpenGL ES at all, @c \@requires_gles30 for functionality -requiring OpenGL ES 3.0 (i.e. not part of OpenGL 2.0) and -@c \@requires_es_extension for specific extensions not part of OpenGL ES -specification. When there is both required desktop OpenGL version/extension -and OpenGL ES version/extension, first come desktop requirements, then ES -requirements. +not available in OpenGL ES at all, @c \@requires_glesXX for functionality +requiring OpenGL ES X.X, @c \@requires_gles for functionality requiring OpenGL +ES and not available in WebGL, @c \@requires_webgl20 for functionality +requiring WebGL 2.0 (i.e., not part of WebGL 1.0), @c \@requires_es_extension +for specific extensions not part of the core OpenGL ES specification and +@c \@requires_webgl_extension for specific extensions not part of the core +WebGL specification. When there is more than just a single platform, first come +desktop requirements, then ES requirements and WebGL requirements last. All classes and functions using those commands are cross-referenced in page @ref opengl-required-extensions. diff --git a/doc/snippets/coding-style.h b/doc/snippets/coding-style.h index ee6a7b528..aba5d43a1 100644 --- a/doc/snippets/coding-style.h +++ b/doc/snippets/coding-style.h @@ -25,6 +25,10 @@ inline Collision operator/(const Point& a, const Sphere& b) { return (b/a).rever /** @gl_extension2{NV,read_buffer_front,GL_NV_read_buffer} */ /* [extension2] */ +/* [webgl_extension] */ +/** @webgl_extension{EXT,color_buffer_float} */ +/* [webgl_extension] */ + /* [al_extension] */ /** @al_extension{EXT,float32}, @alc_extension{SOFT,HRTF} */ /* [al_extension] */