diff --git a/src/Magnum/Platform/EmscriptenApplication.h b/src/Magnum/Platform/EmscriptenApplication.h index 3c7f2659c..ddc1fb2e2 100644 --- a/src/Magnum/Platform/EmscriptenApplication.h +++ b/src/Magnum/Platform/EmscriptenApplication.h @@ -1006,8 +1006,10 @@ class EmscriptenApplication::GLConfiguration { * @brief Set context flags * @return Reference to self (for method chaining) * - * Default is @ref Flag::EnableExtensionsByDefault. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * Default is @ref Flag::EnableExtensionsByDefault. To avoid clearing + * default flags by accident, prefer to use @ref addFlags() and + * @ref clearFlags() instead. + * @see @ref GL::Context::flags() */ GLConfiguration& setFlags(Flags flags) { _flags = flags; diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index 3706d7e5d..c45d403ce 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -834,8 +834,9 @@ class GlfwApplication::GLConfiguration { * @return Reference to self (for method chaining) * * Default is @ref Flag::ForwardCompatible on desktop GL and no flags - * on OpenGL ES. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * on OpenGL ES. To avoid clearing default flags by accident, prefer to + * use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() */ GLConfiguration& setFlags(Flags flags) { _flags = flags; @@ -1250,7 +1251,9 @@ class GlfwApplication::Configuration { * @brief Set window flags * @return Reference to self (for method chaining) * - * Default is @ref WindowFlag::Focused. + * Default is @ref WindowFlag::Focused. To avoid clearing default flags + * by accident, prefer to use @ref addWindowFlags() and + * @ref clearWindowFlags() instead. */ Configuration& setWindowFlags(WindowFlags windowFlags) { _windowFlags = windowFlags; diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index ec37791f6..91fb46abb 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -1288,8 +1288,9 @@ class Sdl2Application::GLConfiguration { * @return Reference to self (for method chaining) * * Default is @ref Flag::ForwardCompatible on desktop GL and no flags - * on OpenGL ES. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * on OpenGL ES. To avoid clearing default flags by accident, prefer to + * use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() * @requires_gles Context flags are not available in WebGL. */ GLConfiguration& setFlags(Flags flags) { @@ -1823,7 +1824,9 @@ class Sdl2Application::Configuration { * @brief Set window flags * @return Reference to self (for method chaining) * - * Default are none. + * Default are none. To avoid clearing default flags by accident, + * prefer to use @ref addWindowFlags() and @ref clearWindowFlags() + * instead. */ Configuration& setWindowFlags(WindowFlags flags) { _windowFlags = flags; diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index e9b9f06bb..ec17eb69a 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -231,8 +231,9 @@ class WindowlessEglContext::Configuration { * @return Reference to self (for method chaining) * * Default is @ref Flag::ForwardCompatible on desktop GL and no flags - * on OpenGL ES. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * on OpenGL ES. To avoid clearing default flags by accident, prefer to + * use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() * @requires_gles Context flags are not available in WebGL. */ Configuration& setFlags(Flags flags) { diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 2647d7fac..9577f2197 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -228,8 +228,9 @@ class WindowlessGlxContext::Configuration { * @return Reference to self (for method chaining) * * Default is @ref Flag::ForwardCompatible on desktop GL and no flags - * on OpenGL ES. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * on OpenGL ES. To avoid clearing default flags by accident, prefer to + * use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() */ Configuration& setFlags(Flags flags) { _flags = flags; diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index 3ff1021b0..999880de2 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -215,8 +215,9 @@ class WindowlessWglContext::Configuration { * @return Reference to self (for method chaining) * * Default is @ref Flag::ForwardCompatible on desktop GL and no flags - * on OpenGL ES. - * @see @ref addFlags(), @ref clearFlags(), @ref GL::Context::flags() + * on OpenGL ES. To avoid clearing default flags by accident, prefer to + * use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() */ Configuration& setFlags(Flags flags) { _flags = flags; diff --git a/src/Magnum/Platform/WindowlessWindowsEglApplication.h b/src/Magnum/Platform/WindowlessWindowsEglApplication.h index 06c209bb0..49c28621d 100644 --- a/src/Magnum/Platform/WindowlessWindowsEglApplication.h +++ b/src/Magnum/Platform/WindowlessWindowsEglApplication.h @@ -190,7 +190,9 @@ class WindowlessWindowsEglContext::Configuration { * @brief Set context flags * @return Reference to self (for method chaining) * - * Default is no flag. See also @ref GL::Context::flags(). + * Default is no flag. To avoid clearing default flags by accident, + * prefer to use @ref addFlags() and @ref clearFlags() instead. + * @see @ref GL::Context::flags() */ Configuration& setFlags(Flags flags) { _flags = flags;