diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index 99a6bd6ca..c709e89aa 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -54,6 +54,8 @@ namespace Magnum { namespace Platform { /** @nosubgrouping @brief Android application +@m_keywords{Application} + Application running on Android. This application library is available only on diff --git a/src/Magnum/Platform/EmscriptenApplication.h b/src/Magnum/Platform/EmscriptenApplication.h index d3ca29890..b6135bb0a 100644 --- a/src/Magnum/Platform/EmscriptenApplication.h +++ b/src/Magnum/Platform/EmscriptenApplication.h @@ -57,6 +57,8 @@ namespace Magnum { namespace Platform { /** @nosubgrouping @brief Emscripten application +@m_keywords{Application} + Application running on Emscripten. This application library is available only on diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index c33498f09..948738f28 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -58,6 +58,8 @@ namespace Implementation { /** @nosubgrouping @brief GLFW application +@m_keywords{Application} + Application using the [GLFW](http://glfw.org) toolkit. Supports keyboard and mouse handling with support for changing cursor and mouse tracking and warping. diff --git a/src/Magnum/Platform/GlxApplication.h b/src/Magnum/Platform/GlxApplication.h index 06c2062a1..c60279d97 100644 --- a/src/Magnum/Platform/GlxApplication.h +++ b/src/Magnum/Platform/GlxApplication.h @@ -40,6 +40,8 @@ namespace Magnum { namespace Platform { /** @brief GLX application +@m_keywords{Application} + Application using pure X11 and GLX. Supports keyboard and mouse handling. This application library is available on desktop OpenGL and diff --git a/src/Magnum/Platform/Screen.h b/src/Magnum/Platform/Screen.h index c0ca20772..80ba7a096 100644 --- a/src/Magnum/Platform/Screen.h +++ b/src/Magnum/Platform/Screen.h @@ -50,6 +50,8 @@ CORRADE_ENUMSET_OPERATORS(PropagatedScreenEvents) /** @brief Base for application screens +@m_keywords{Screen} + See @ref BasicScreenedApplication for more information. If exactly one application header is included, this class is also aliased to diff --git a/src/Magnum/Platform/ScreenedApplication.h b/src/Magnum/Platform/ScreenedApplication.h index b41329b12..22fefc91f 100644 --- a/src/Magnum/Platform/ScreenedApplication.h +++ b/src/Magnum/Platform/ScreenedApplication.h @@ -40,6 +40,8 @@ namespace Magnum { namespace Platform { /** @brief Base for applications with screen management +@m_keywords{ScreenedApplication} + Manages list of screens and propagates events to them. If exactly one application header is included, this class is also aliased to diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index a9eb1ccc5..28c25de4e 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -70,6 +70,8 @@ namespace Implementation { /** @nosubgrouping @brief SDL2 application +@m_keywords{Application} + Application using [Simple DirectMedia Layer](http://www.libsdl.org/) toolkit. Supports keyboard and mouse handling. diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index 61c109fda..45af87c49 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -50,6 +50,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless CGL context +@m_keywords{WindowlessGLContext} + GL context used in @ref WindowlessCglApplication. Does not have any default framebuffer. It is built if `WITH_WINDOWLESSCGLAPPLICATION` is enabled in CMake. @@ -143,6 +145,8 @@ class WindowlessCglContext::Configuration { /** @brief Windowless CGL application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessCglContext. This application library is available on desktop OpenGL on macOS. It is built if `WITH_WINDOWLESSCGLAPPLICATION` is enabled in CMake. diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index a76dfa2a6..38366d8c5 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -52,6 +52,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless EGL context +@m_keywords{WindowlessGLContext} + GL context using EGL without any windowing system, used in @ref WindowlessEglApplication. Does not have any default framebuffer. It is built if `WITH_WINDOWLESSEGLAPPLICATION` is enabled in CMake. @@ -247,6 +249,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessEglContext::Configuration::Flags) /** @brief Windowless EGL application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessEglContext. This application library is in theory available for all platforms for which EGL works (Linux desktop or ES, @ref CORRADE_TARGET_IOS "iOS", diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 00a5fc951..ba1b1a3b3 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -56,6 +56,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless GLX context +@m_keywords{WindowlessGLContext} + GL context using pure X11 and GLX, used in @ref WindowlessGlxApplication. Does not have any default framebuffer. It is built if `WITH_WINDOWLESSGLXAPPLICATION` is enabled in CMake. @@ -241,6 +243,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessGlxContext::Configuration::Flags) /** @brief Windowless GLX application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessGlxContext. This application library is available on desktop OpenGL and @ref MAGNUM_TARGET_DESKTOP_GLES "OpenGL ES emulation on desktop" on Linux. It diff --git a/src/Magnum/Platform/WindowlessIosApplication.h b/src/Magnum/Platform/WindowlessIosApplication.h index 9ab7e67ee..58418d8c0 100644 --- a/src/Magnum/Platform/WindowlessIosApplication.h +++ b/src/Magnum/Platform/WindowlessIosApplication.h @@ -51,6 +51,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless iOS context +@m_keywords{WindowlessGLContext} + GL context using EAGL on iOS, used in @ref WindowlessIosApplication. Does not have any default framebuffer. It is built if `WITH_WINDOWLESSIOSAPPLICATION` is enabled in CMake. @@ -138,6 +140,8 @@ class WindowlessIosContext::Configuration { /** @brief Windowless iOS application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessIosContext. Does not have any default framebuffer. It is built if `WITH_WINDOWLESSIOSAPPLICATION` is enabled in CMake. diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index 1a4e6beeb..969c41bf9 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -57,6 +57,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless WGL context +@m_keywords{WindowlessGLContext} + GL context using pure WINAPI, used in @ref WindowlessWglApplication. It is built if `WITH_WINDOWLESSWGLAPPLICATION` is enabled in CMake. @@ -241,6 +243,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWglContext::Configuration::Flags) /** @brief Windowless WGL application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessWglContext. This application library is available on desktop OpenGL on Windows. It is built if `WITH_WINDOWLESSWGLAPPLICATION` is enabled in CMake. diff --git a/src/Magnum/Platform/WindowlessWindowsEglApplication.h b/src/Magnum/Platform/WindowlessWindowsEglApplication.h index 48c85d486..252ea57a4 100644 --- a/src/Magnum/Platform/WindowlessWindowsEglApplication.h +++ b/src/Magnum/Platform/WindowlessWindowsEglApplication.h @@ -52,6 +52,8 @@ namespace Magnum { namespace Platform { /** @brief Windowless Windows/EGL context +@m_keywords{WindowlessGLContext} + GL context using pure WINAPI and EGL, used in @ref WindowlessWindowsEglApplication. It is built if `WITH_WINDOWLESSWINDOWSEGLAPPLICATION` is enabled in CMake. @@ -211,6 +213,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWindowsEglContext::Configuration::Flags) /** @brief Windowless Windows/EGL application +@m_keywords{WindowlessApplication} + Application for offscreen rendering using @ref WindowlessWindowsEglContext. This application library is available on OpenGL ES (also ANGLE) on Windows. It is built if `WITH_WINDOWLESSWINDOWSEGLAPPLICATION` is enabled in CMake. diff --git a/src/Magnum/Platform/XEglApplication.h b/src/Magnum/Platform/XEglApplication.h index ed11f2b49..972e9a0aa 100644 --- a/src/Magnum/Platform/XEglApplication.h +++ b/src/Magnum/Platform/XEglApplication.h @@ -40,6 +40,8 @@ namespace Magnum { namespace Platform { /** @brief X/EGL application +@m_keywords{Application} + Application using pure X11 and EGL. Supports keyboard and mouse handling. This application library is available on both desktop OpenGL and