Browse Source

Doxygen warning fixes.

pull/158/head
Vladimír Vondruš 10 years ago
parent
commit
6e666ebdc7
  1. 12
      doc/platform.dox
  2. 2
      src/Magnum/Magnum.h
  3. 2
      src/Magnum/Platform/WindowlessGlxApplication.h
  4. 2
      src/Magnum/Platform/WindowlessIosApplication.h
  5. 2
      src/Magnum/Platform/WindowlessWglApplication.h

12
doc/platform.dox

@ -322,12 +322,12 @@ target_link_libraries(myapplication
In case you need to manage windowless OpenGL contexts manually (for example In case you need to manage windowless OpenGL contexts manually (for example
to use Magnum for data processing in a thread or when having more than one to use Magnum for data processing in a thread or when having more than one
OpenGL context), there is a possibility to directly use the context wrappers OpenGL context), there is a possibility to directly use the context wrappers
from windowless applications. Each @ref WindowlessEglApplication "Windowless*Application" from windowless applications. Each @ref Platform::WindowlessEglApplication "Platform::Windowless*Application"
is accompanied by a @ref WindowlessEglContext "Windowless*Context" class that is accompanied by a @ref Platform::WindowlessEglContext "Platform::Windowless*Context"
manages just GL context creation, making it current and destruction. Similarly class that manages just GL context creation, making it current and destruction.
to using custom platform toolkits above, the workflow is to first create a GL Similarly to using custom platform toolkits above, the workflow is to first
context instance, then making it current and finally instantiating the create a GL context instance, then making it current and finally instantiating
@ref Platform::Context instance to initialize Magnum. the @ref Platform::Context instance to initialize Magnum.
Similarly as with the applications, to simplify the porting, the library Similarly as with the applications, to simplify the porting, the library
provides `Platform::WindowlessGLContext` typedef, but only if just one provides `Platform::WindowlessGLContext` typedef, but only if just one

2
src/Magnum/Magnum.h

@ -96,7 +96,7 @@ Defined if built as static libraries. Default are shared libraries.
Defined if the library is built in a way that allows multiple thread-local Defined if the library is built in a way that allows multiple thread-local
Magnum contexts. Enabled by default. Magnum contexts. Enabled by default.
@see @ref building, @ref cmake, @ref Context::current() @see @ref building, @ref cmake, @ref Magnum::Context::current() "Context::current()"
*/ */
#define MAGNUM_BUILD_MULTITHREADED #define MAGNUM_BUILD_MULTITHREADED
#undef MAGNUM_BUILD_MULTITHREADED #undef MAGNUM_BUILD_MULTITHREADED

2
src/Magnum/Platform/WindowlessGlxApplication.h

@ -76,7 +76,7 @@ class WindowlessGlxContext {
* on binary AMD and NVidia drivers, creating core context does not use * on binary AMD and NVidia drivers, creating core context does not use
* the largest available version. If the application detects such case * the largest available version. If the application detects such case
* (and given workaround is not disabled in optionally passed * (and given workaround is not disabled in optionally passed
* @ref context instance), the core context is destroyed and * @p context instance), the core context is destroyed and
* compatibility OpenGL 2.1 context is created instead to make the * compatibility OpenGL 2.1 context is created instead to make the
* driver use the latest available version. * driver use the latest available version.
* *

2
src/Magnum/Platform/WindowlessIosApplication.h

@ -118,7 +118,7 @@ class WindowlessIosContext {
@brief Configuration @brief Configuration
@see @ref WindowlessIosContext(), @see @ref WindowlessIosContext(),
@ref WindowlessIosApplication::WindowlessCglApplication(), @ref WindowlessIosApplication::WindowlessIosApplication(),
@ref WindowlessIosApplication::createContext(), @ref WindowlessIosApplication::createContext(),
@ref WindowlessIosApplication::tryCreateContext() @ref WindowlessIosApplication::tryCreateContext()
*/ */

2
src/Magnum/Platform/WindowlessWglApplication.h

@ -77,7 +77,7 @@ class WindowlessWglContext {
* on binary AMD and NVidia drivers, creating core context does not use * on binary AMD and NVidia drivers, creating core context does not use
* the largest available version. If the application detects such case * the largest available version. If the application detects such case
* (and given workaround is not disabled in optionally passed * (and given workaround is not disabled in optionally passed
* @ref context instance), the core context is destroyed and * @p context instance), the core context is destroyed and
* compatibility OpenGL 2.1 context is created instead to make the * compatibility OpenGL 2.1 context is created instead to make the
* driver use the latest available version. * driver use the latest available version.
* *

Loading…
Cancel
Save