From f7e41d6e96e23a3893ad9b614654960e25f4472f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 1 Feb 2020 20:21:27 +0100 Subject: [PATCH] Platform: add search aliases to have things discoverable betters. --- src/Magnum/Platform/AndroidApplication.h | 2 ++ src/Magnum/Platform/EmscriptenApplication.h | 2 ++ src/Magnum/Platform/GlfwApplication.h | 2 ++ src/Magnum/Platform/GlxApplication.h | 2 ++ src/Magnum/Platform/Sdl2Application.h | 2 ++ src/Magnum/Platform/WindowlessCglApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessEglApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessGlxApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessIosApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessWglApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessWindowsEglApplication.h | 6 ++++-- src/Magnum/Platform/XEglApplication.h | 2 ++ 12 files changed, 36 insertions(+), 12 deletions(-) diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index 866a9e16b..75fa85bca 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -812,6 +812,8 @@ CORRADE_ENUMSET_OPERATORS(AndroidApplication::MouseMoveEvent::Buttons) @brief Entry point for Android applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::AndroidApplication "Platform::AndroidApplication" for usage information. This macro abstracts out platform-specific entry point code (the classic @cpp main() @ce function cannot be used in Android). See diff --git a/src/Magnum/Platform/EmscriptenApplication.h b/src/Magnum/Platform/EmscriptenApplication.h index 643bc6720..ad8182334 100644 --- a/src/Magnum/Platform/EmscriptenApplication.h +++ b/src/Magnum/Platform/EmscriptenApplication.h @@ -1789,6 +1789,8 @@ class EmscriptenApplication::TextInputEvent { @brief Entry point for Emscripten applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::EmscriptenApplication "Platform::EmscriptenApplication" for usage information. This macro abstracts out platform-specific entry point code. See @ref portability-applications for more information. diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index 994cc60b9..f62853ac6 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -1921,6 +1921,8 @@ class GlfwApplication::TextInputEvent { @brief Entry point for GLFW-based applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::GlfwApplication "Platform::GlfwApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for more diff --git a/src/Magnum/Platform/GlxApplication.h b/src/Magnum/Platform/GlxApplication.h index 6d7f3f2a9..86f1bf049 100644 --- a/src/Magnum/Platform/GlxApplication.h +++ b/src/Magnum/Platform/GlxApplication.h @@ -127,6 +127,8 @@ class GlxApplication: public AbstractXApplication { @brief Entry point for GLX-based applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::GlxApplication "Platform::GlxApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for more diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index 0cd2f5596..e7ec24914 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -2650,6 +2650,8 @@ class Sdl2Application::TextEditingEvent { @brief Entry point for SDL2-based applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::Sdl2Application "Platform::Sdl2Application" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following on all supported platforms except diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index 280063b4f..112d1f347 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -53,7 +53,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless CGL context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext CGL} GL context used in @ref WindowlessCglApplication. Does not have any default framebuffer. @@ -147,7 +147,7 @@ class WindowlessCglContext::Configuration { /** @brief Windowless CGL application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication CGL} Application for offscreen rendering using @ref WindowlessCglContext. This application library is available on desktop OpenGL on macOS. @@ -328,6 +328,8 @@ class WindowlessCglApplication { @brief Entry point for windowless CGL application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessCglApplication "Platform::WindowlessCglApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index 4ce884503..0cde69813 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -52,7 +52,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless EGL context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext EGL} GL context using EGL without any windowing system, used in @ref WindowlessEglApplication. Does not have any default framebuffer. @@ -271,7 +271,7 @@ CORRADE_ENUMSET_OPERATORS(WindowlessEglContext::Configuration::Flags) /** @brief Windowless EGL application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication EGL} Application for offscreen rendering using @ref WindowlessEglContext. This application library is in theory available for all platforms for which EGL @@ -539,6 +539,8 @@ class WindowlessEglApplication { @brief Entry point for windowless EGL application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessEglApplication "Platform::WindowlessEglApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 2dce87e66..cefbf122f 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -56,7 +56,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless GLX context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext GLX} GL context using pure X11 and GLX, used in @ref WindowlessGlxApplication. Does not have any default framebuffer. @@ -242,7 +242,7 @@ CORRADE_ENUMSET_OPERATORS(WindowlessGlxContext::Configuration::Flags) /** @brief Windowless GLX application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication GLX} Application for offscreen rendering using @ref WindowlessGlxContext. This application library is available on desktop OpenGL and @@ -426,6 +426,8 @@ class WindowlessGlxApplication { @brief Entry point for windowless GLX application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessGlxApplication "Platform::WindowlessGlxApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/WindowlessIosApplication.h b/src/Magnum/Platform/WindowlessIosApplication.h index 25f6c46b5..444383cf0 100644 --- a/src/Magnum/Platform/WindowlessIosApplication.h +++ b/src/Magnum/Platform/WindowlessIosApplication.h @@ -51,7 +51,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless iOS context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext EGL EAGL} GL context using EAGL on iOS, used in @ref WindowlessIosApplication. Does not have any default framebuffer. @@ -139,7 +139,7 @@ class WindowlessIosContext::Configuration { /** @brief Windowless iOS application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication EGL EAGL} Application for offscreen rendering using @ref WindowlessIosContext. Does not have any default framebuffer. @@ -322,6 +322,8 @@ class WindowlessIosApplication { @brief Entry point for windowless EGL application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessIosApplication "Platform::WindowlessIosApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index 65af79609..f3c461075 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -57,7 +57,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless WGL context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext WGL} GL context using pure WINAPI, used in @ref WindowlessWglApplication. @@ -242,7 +242,7 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWglContext::Configuration::Flags) /** @brief Windowless WGL application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication WGL} Application for offscreen rendering using @ref WindowlessWglContext. This application library is available on desktop OpenGL on Windows. @@ -424,6 +424,8 @@ class WindowlessWglApplication { @brief Entry point for windowless WGL application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessWglApplication "Platform::WindowlessWglApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/WindowlessWindowsEglApplication.h b/src/Magnum/Platform/WindowlessWindowsEglApplication.h index a64a588fd..694f44dd2 100644 --- a/src/Magnum/Platform/WindowlessWindowsEglApplication.h +++ b/src/Magnum/Platform/WindowlessWindowsEglApplication.h @@ -52,7 +52,7 @@ namespace Magnum { namespace Platform { /** @brief Windowless Windows/EGL context -@m_keywords{WindowlessGLContext} +@m_keywords{WindowlessGLContext EGL} GL context using pure WINAPI and EGL, used in @ref WindowlessWindowsEglApplication. @@ -212,7 +212,7 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWindowsEglContext::Configuration::Flags) /** @brief Windowless Windows/EGL application -@m_keywords{WindowlessApplication} +@m_keywords{WindowlessApplication EGL} Application for offscreen rendering using @ref WindowlessWindowsEglContext. This application library is available on OpenGL ES (also ANGLE) on Windows. @@ -393,6 +393,8 @@ class WindowlessWindowsEglApplication { @brief Entry point for windowless Windows/EGL application @param className Class name +@m_keywords{MAGNUM_WINDOWLESSAPPLICATION_MAIN()} + See @ref Magnum::Platform::WindowlessWindowsEglApplication "Platform::WindowlessWindowsEglApplication" for usage information.This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for diff --git a/src/Magnum/Platform/XEglApplication.h b/src/Magnum/Platform/XEglApplication.h index 9bde6c950..f659fae59 100644 --- a/src/Magnum/Platform/XEglApplication.h +++ b/src/Magnum/Platform/XEglApplication.h @@ -130,6 +130,8 @@ class XEglApplication: public AbstractXApplication { @brief Entry point for X/EGL-based applications @param className Class name +@m_keywords{MAGNUM_APPLICATION_MAIN()} + See @ref Magnum::Platform::XEglApplication "Platform::XEglApplication" for usage information. This macro abstracts out platform-specific entry point code and is equivalent to the following, see @ref portability-applications for more