From f98b39df4f435fdbbd833b065334a77c6fc5c910 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 12 Aug 2014 20:53:22 +0200 Subject: [PATCH] Doc++, minor cleanup. --- CMakeLists.txt | 2 +- doc/cmake.dox | 21 ++++++++++--------- doc/platform.dox | 8 +++---- .../Implementation/OpenGLFunctionLoader.h | 2 +- 4 files changed, 17 insertions(+), 16 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 43804efc6..ba907f8c1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -63,7 +63,7 @@ elseif(CORRADE_TARGET_APPLE) cmake_dependent_option(WITH_WINDOWLESSCGLAPPLICATION "Build WindowlessCglApplication library" OFF "NOT WITH_MAGNUMINFO;NOT WITH_FONTCONVERTER;NOT WITH_DISTANCEFIELDCONVERTER" ON) cmake_dependent_option(WITH_CGLCONTEXT "Build CglContext library" OFF "NOT TARGET_GLES" OFF) -# X11, GLX and EGL-specific application libraries +# X11 + GLX/EGL-specific application libraries elseif(CORRADE_TARGET_UNIX) option(WITH_GLXAPPLICATION "Build GlxApplication library" OFF) cmake_dependent_option(WITH_WINDOWLESSGLXAPPLICATION "Build WindowlessGlxApplication library" OFF "NOT WITH_MAGNUMINFO;NOT WITH_FONTCONVERTER;NOT WITH_DISTANCEFIELDCONVERTER" ON) diff --git a/doc/cmake.dox b/doc/cmake.dox index 1618241b5..524086e17 100644 --- a/doc/cmake.dox +++ b/doc/cmake.dox @@ -79,16 +79,16 @@ components. The base library depends on %Corrade and OpenGL libraries (or OpenGL ES libraries). Additional dependencies are specified by the components. The optional components are: -- `%Audio` -- Audio library -- `%DebugTools` -- DebugTools library (depends on `%MeshTools`, +- `%Audio` -- @ref Audio library +- `%DebugTools` -- @ref DebugTools library (depends on `%MeshTools`, `%Primitives`, `%SceneGraph`, `%Shaders` and `%Shapes` components) -- `%MeshTools` -- MeshTools library -- `%Primitives` -- Primitives library -- `%SceneGraph` -- SceneGraph library -- `%Shaders` -- Shaders library -- `%Shapes` -- Shapes library (depends on `%SceneGraph` component) -- `%Text` -- Text library (depends on `%TextureTools` component) -- `%TextureTools` -- TextureTools library +- `%MeshTools` -- @ref MeshTools library +- `%Primitives` -- @ref Primitives library +- `%SceneGraph` -- @ref SceneGraph library +- `%Shaders` -- @ref Shaders library +- `%Shapes` -- @ref Shapes library (depends on `%SceneGraph` component) +- `%Text` -- @ref Text library (depends on `%TextureTools` component) +- `%TextureTools` -- @ref TextureTools library Platform namespace is split into more components: @@ -103,7 +103,8 @@ Platform namespace is split into more components: - `%WindowlessWglApplication` -- @ref Platform::WindowlessWglApplication "WindowlessWglApplication" For manual context creation (without application wrappers) there are also -platform-specific context libraries: +platform-specific context libraries (see @ref platfom-custom for more +information): - `CglContext` -- CGL context - `GlxContext` -- GLX context diff --git a/doc/platform.dox b/doc/platform.dox index 3f23085b8..e6a4199f4 100644 --- a/doc/platform.dox +++ b/doc/platform.dox @@ -292,11 +292,11 @@ pointer loading using platform-specific APIs. In that case you also need to find particular `*Context` library, add its include dir and then link to it. These platform-specific libraries are available: -- `CglContext` -- CGL context -- `GlxContext` -- GLX context -- `WglContext` -- WGL context +- `CglContext` -- CGL context (Mac OS X) +- `GlxContext` -- GLX context (X11-based Unix) +- `WglContext` -- WGL context (Windows) -Systems not listed here (such as Emscripten or NaCl) don't need any Context +Systems not listed here (such as Emscripten or NaCl) don't need any `Context` library, because dynamic function pointer loading is not available on these. For example, when you create the OpenGL context using GLX, you need to find diff --git a/src/Magnum/Platform/Implementation/OpenGLFunctionLoader.h b/src/Magnum/Platform/Implementation/OpenGLFunctionLoader.h index 0efa76127..986f99117 100644 --- a/src/Magnum/Platform/Implementation/OpenGLFunctionLoader.h +++ b/src/Magnum/Platform/Implementation/OpenGLFunctionLoader.h @@ -56,7 +56,7 @@ class OpenGLFunctionLoader { #elif defined(CORRADE_TARGET_WINDOWS) HMODULE library; - /* GLX-specific handles (nothing needed */ + /* GLX-specific handles (nothing needed) */ #elif defined(CORRADE_TARGET_UNIX) && defined(MAGNUM_PLATFORM_USE_GLX) /* Otherwise unsupported */