Browse Source

Platform: add search aliases to have things discoverable betters.

pull/420/head
Vladimír Vondruš 6 years ago
parent
commit
f7e41d6e96
  1. 2
      src/Magnum/Platform/AndroidApplication.h
  2. 2
      src/Magnum/Platform/EmscriptenApplication.h
  3. 2
      src/Magnum/Platform/GlfwApplication.h
  4. 2
      src/Magnum/Platform/GlxApplication.h
  5. 2
      src/Magnum/Platform/Sdl2Application.h
  6. 6
      src/Magnum/Platform/WindowlessCglApplication.h
  7. 6
      src/Magnum/Platform/WindowlessEglApplication.h
  8. 6
      src/Magnum/Platform/WindowlessGlxApplication.h
  9. 6
      src/Magnum/Platform/WindowlessIosApplication.h
  10. 6
      src/Magnum/Platform/WindowlessWglApplication.h
  11. 6
      src/Magnum/Platform/WindowlessWindowsEglApplication.h
  12. 2
      src/Magnum/Platform/XEglApplication.h

2
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

2
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.

2
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

2
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

2
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

6
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

6
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

6
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

6
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

6
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

6
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

2
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

Loading…
Cancel
Save