From 02afa105dbaa161bd4a1c4e3f1bf15073c49ac61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 7 Dec 2013 21:40:00 +0100 Subject: [PATCH] Doc++ --- doc/building.dox | 10 ++++------ doc/platform.dox | 9 ++++++--- src/Platform/AbstractXApplication.h | 4 ++-- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/building.dox b/doc/building.dox index c9be98045..08d302075 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -104,12 +104,10 @@ within QtCreator by adding new `make install` build rule. @subsubsection building-windows-troubleshooting Windows troubleshooting -If CMake isn't able to find dependencies (e.g. %Corrade is not found) and you -have installed them to MinGW directory, point to `CMAKE_FIND_ROOT_PATH` to -MinGW installation prefix, e.g. specify `-DCMAKE_FIND_ROOT_PATH=C:/MinGW/` -CMake parameter. - -See also Corrade's @ref building-corrade-windows-troubleshooting "troubleshooting section". +If CMake isn't able to find dependencies (e.g. %Corrade is not found), point +`CMAKE_FIND_ROOT_PATH` and `CMAKE_INSTALL_PREFIX` to installation prefix of +dependency libraries, e.g. specify `-DCMAKE_FIND_ROOT_PATH=C:/MinGW/` CMake +parameter. @subsection building-features Enabling or disabling features diff --git a/doc/platform.dox b/doc/platform.dox index 463066526..92574996b 100644 --- a/doc/platform.dox +++ b/doc/platform.dox @@ -55,7 +55,8 @@ directly in `main()`, but for convenience and portability it's better to use To simplify the porting, the library provides `Platform::Application` typedef and `MAGNUM_APPLICATION_MAIN()` macro (but only if only one application header is included, to avoid ambiguity). Changing the code to use different toolkit is -then matter of replacing only the #`include` statement. +then matter of replacing only the #`include` statement (and changing +one line in CMake build script, as you see later). Barebone application implementation which will just clear the window to dark blue color is shown in the following code listing. @@ -76,6 +77,7 @@ class MyApplication: public Platform::Application { public: MyApplication(const Arguments& arguments); + private: void viewportEvent(const Vector2i& viewport) override; void drawEvent() override; }; @@ -166,8 +168,9 @@ to it. Again, to simplify porting, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and `${MAGNUM_WAPPLICATION_LIBRARIES}` aliases (or `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}`, `${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` for windowless applications), but only if only one application (windowless application) component is requested to -avoid ambiguity. Changing the code to use different toolkit is then matter of -replacing only the requested `*Application` component. +avoid ambiguity. Changing the build script to use different toolkit is then +matter of replacing only the requested `*Application` component (and one +#`include` line in the actual code, as said above). @code find_package(Magnum REQUIRED GlutApplication) diff --git a/src/Platform/AbstractXApplication.h b/src/Platform/AbstractXApplication.h index 8e8a1ec40..b1cd8c867 100644 --- a/src/Platform/AbstractXApplication.h +++ b/src/Platform/AbstractXApplication.h @@ -193,8 +193,8 @@ CORRADE_ENUMSET_OPERATORS(AbstractXApplication::Flags) @brief %Configuration Double-buffered OpenGL context. -@see @ref GlxApplication(), @ref XEglApplication(), @ref createContext(), - @ref tryCreateContext() +@see @ref GlxApplication::GlxApplication(), @ref XeglApplication::XEglApplication(), + @ref createContext(), @ref tryCreateContext() @todo GLX_ARB_create_context_robustness/EGL_EXT_create_context_robustness */ class AbstractXApplication::Configuration {