Platform: thoroughly documented building and usage with CMake.

src/Platform/AbstractXApplication.h

@@ -55,7 +55,9 @@ namespace Implementation {
 @brief Base for X11-based applications
 
 Supports keyboard and mouse handling. See @ref platform for brief introduction.
-@note Not meant to be used directly, see subclasses.
+
+@note Not meant to be used directly, see @ref GlxApplication and
+    @ref XEglApplication subclasses.
 */
 class AbstractXApplication {
     public:

src/Platform/GlutApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::GlutApplication
+ * @brief Class @ref Magnum::Platform::GlutApplication
  */
 
 #include <string>
@@ -45,23 +45,31 @@ namespace Platform {
 /** @nosubgrouping
 @brief GLUT application
 
-Supports keyboard handling for limited subset of keys, mouse handling with
+Application using GLUT toolkit. Supports keyboard handling for limited subset
-support for changing cursor and mouse tracking and warping. See @ref platform
+of keys, mouse handling with support for changing cursor and mouse tracking and
-for brief introduction.
+warping. See @ref platform for brief introduction.
+
+This application library is available only on desktop OpenGL (Linux, Windows,
+OS X). It depends on **GLUT** library and is built if `WITH_GLUTAPPLICATION` is
+enabled in CMake. To use it, you need to request `%GlutApplication` component
+in CMake, add `${MAGNUM_GLUTAPPLICATION_INCLUDE_DIRS}` to include path and link
+to `${MAGNUM_GLUTAPPLICATION_LIBRARIES}`. If no other application is requested,
+you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting.
 
 @section GlutApplication-usage Usage
 
-You need to implement at least drawEvent() and viewportEvent() to be able to
+You need to implement at least @ref drawEvent() and @ref viewportEvent() to be
-draw on the screen. The subclass can be then used directly in `main()` -- see
+able to draw on the screen. The subclass can be then used directly in `main()`
-convenience macro MAGNUM_GLUTAPPLICATION_MAIN().
+-- see convenience macro @ref MAGNUM_GLUTAPPLICATION_MAIN().
 @code
-class MyApplication: public Magnum::Platform::GlutApplication {
+class MyApplication: public Platform::GlutApplication {
     // implement required methods...
 };
 MAGNUM_GLUTAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::Application` and the macro is aliased to `MAGNUM_APPLICATION_MAIN()`
 to simplify porting.
 */

src/Platform/GlxApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::GlxApplication
+ * @brief Class @ref Magnum::Platform::GlxApplication
  */
 
 #include "Platform/AbstractXApplication.h"
@@ -35,21 +35,31 @@ namespace Magnum { namespace Platform {
 /**
 @brief GLX application
 
-Uses GlxContextHandler. See @ref platform for brief introduction.
+Application using pure X11 and GLX. Supports keyboard and mouse handling. See
+@ref platform for brief introduction.
+
+This application library is available on desktop OpenGL and
+@ref MAGNUM_TARGET_DESKTOP_GLES "OpenGL ES emulation on desktop" on Linux. It
+depends on **X11** library and is built if `WITH_GLXAPPLICATION` is enabled in
+CMake. To use it, you need to request `%GlxApplication` component in CMake, add
+`${MAGNUM_GLXAPPLICATION_INCLUDE_DIRS}` to include path and link to
+`${MAGNUM_GLXAPPLICATION_LIBRARIES}`. If no other application is requested, you
+can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting.
 
 @section GlxApplication-usage Usage
 
-You need to implement at least drawEvent() and viewportEvent() to be able to
+You need to implement at least @ref drawEvent() and @ref viewportEvent() to be
-draw on the screen. The subclass can be then used directly in `main()` - see
+able to draw on the screen. The subclass can be then used directly in `main()`
-convenience macro MAGNUM_GLXAPPLICATION_MAIN().
+-- see convenience macro @ref MAGNUM_GLXAPPLICATION_MAIN().
 @code
-class MyApplication: public Magnum::Platform::GlxApplication {
+class MyApplication: public Platform::GlxApplication {
     // implement required methods...
 };
 MAGNUM_GLXAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::Application` and the macro is aliased to `MAGNUM_APPLICATION_MAIN()`
 to simplify porting.
 */

src/Platform/NaClApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::NaClApplication
+ * @brief Class @ref Magnum::Platform::NaClApplication
  */
 
 #include <string>
@@ -55,19 +55,27 @@ namespace Magnum { namespace Platform {
 Application running in [Google Chrome Native Client](https://developers.google.com/native-client/).
 Supports keyboard and mouse handling. See @ref platform for brief introduction.
 
+This application library is available only in @ref CORRADE_TARGET_NACL "Native Client".
+It is built if `WITH_NACLAPPLICATION` is enabled in CMake. To use it, you need
+to request `%NaClApplication` component in CMake, add
+`${MAGNUM_NACLAPPLICATION_INCLUDE_DIRS}` to include path and link to
+`${MAGNUM_NACLAPPLICATION_LIBRARIES}`. If no other application is requested,
+you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting.
+
 @section NaClApplication-usage Usage
 
-You need to implement at least drawEvent() and viewportEvent() to be able to
+You need to implement at least @ref drawEvent() and @ref viewportEvent() to be
-draw on the screen. The subclass must be then registered to NaCl API using
+able to draw on the screen. The subclass must be then registered to NaCl API
-MAGNUM_NACLAPPLICATION_MAIN() macro.
+using @ref MAGNUM_NACLAPPLICATION_MAIN() macro.
 @code
-class MyApplication: public Magnum::Platform::NaClApplication {
+class MyApplication: public Platform::NaClApplication {
     // implement required methods...
 };
 MAGNUM_NACLAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::Application` and the macro is aliased to `MAGNUM_APPLICATION_MAIN()`
 to simplify porting.
 

src/Platform/Sdl2Application.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::Sdl2Application
+ * @brief Class @ref Magnum::Platform::Sdl2Application
  */
 
 #include <Containers/EnumSet.h>
@@ -50,26 +50,37 @@ namespace Platform {
 /** @nosubgrouping
 @brief SDL2 application
 
-Application using [Simple DirectMedia Layer](www.libsdl.org/). Supports
+Application using [Simple DirectMedia Layer](www.libsdl.org/) toolkit. Supports
 keyboard and mouse handling. See @ref platform for brief introduction.
 
+This application library is available on desktop OpenGL (Linux, Windows, OS X)
+and in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten". It depends on **SDL2**
+library (Emscripten has it built in) and is built if `WITH_SDL2APPLICATION` is
+enabled in CMake. To use it, you need to copy `FindSDL2.cmake` from `modules/`
+directory in %Magnum source to `modules/` dir in your project (so CMake is able
+to find SDL2), request `%Sdl2Application` component in CMake, add
+`${MAGNUM_SDL2APPLICATION_INCLUDE_DIRS}` to include path and link to
+`${MAGNUM_SDL2APPLICATION_LIBRARIES}`. If no other application is requested,
+you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting.
+
 @section Sdl2Application-usage Usage
 
-You need to implement at least drawEvent() and viewportEvent() to be able to
+You need to implement at least @ref drawEvent() and @ref viewportEvent() to be
-draw on the screen. The subclass can be then used directly in `main()` -- see
+able to draw on the screen. The subclass can be then used directly in `main()`
-convenience macro MAGNUM_SDL2APPLICATION_MAIN().
+-- see convenience macro @ref MAGNUM_SDL2APPLICATION_MAIN().
 @code
-class MyApplication: public Magnum::Platform::Sdl2Application {
+class MyApplication: public Platform::Sdl2Application {
     // implement required methods...
 };
 MAGNUM_SDL2APPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::Application` and the macro is aliased to `MAGNUM_APPLICATION_MAIN()`
 to simplify porting.
 
-@section NaClApplication-html Usage with Emscripten
+@section Sdl2Application-html Usage with Emscripten
 
 If you are targetting @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten", you need to
 provide HTML markup for your application. Template one is below, you can modify

src/Platform/WindowlessGlxApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::WindowlessGlxApplication
+ * @brief Class @ref Magnum::Platform::WindowlessGlxApplication
  */
 
 #include <utility>
@@ -45,20 +45,31 @@ namespace Magnum { namespace Platform {
 /**
 @brief Windowless GLX application
 
-See @ref platform for brief introduction.
+Application for offscreen rendering using pure X11 and GLX. See @ref platform
+for brief introduction.
+
+This application library is available on desktop OpenGL and
+@ref MAGNUM_TARGET_DESKTOP_GLES "OpenGL ES emulation on desktop" on Linux. It
+depends on **X11** library and is built if `WITH_WINDOWLESSGLXAPPLICATION` is
+enabled in CMake. To use it, you need to request `%WindowlessGlxApplication`
+component in CMake, add `${MAGNUM_WINDOWLESSGLXAPPLICATION_INCLUDE_DIRS}` to
+include path and link to `${MAGNUM_WINDOWLESSGLXAPPLICATION_LIBRARIES}`. If no
+other windowless application is requested, you can also use generic
+`${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting.
 
 @section WindowlessGlxApplication-usage Usage
 
-Place your code into exec(). The subclass can be then used directly in
+Place your code into @ref exec(). The subclass can be then used directly in
-`main()` -- see convenience macro MAGNUM_WINDOWLESSGLXAPPLICATION_MAIN().
+`main()` -- see convenience macro @ref MAGNUM_WINDOWLESSGLXAPPLICATION_MAIN().
 @code
-class MyApplication: public Magnum::Platform::WindowlessGlxApplication {
+class MyApplication: public Platform::WindowlessGlxApplication {
     // implement required methods...
 };
 MAGNUM_WINDOWLESSGLXAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::WindowlessApplication` and the macro is aliased to
 `MAGNUM_WINDOWLESSAPPLICATION_MAIN()` to simplify porting.
 */

src/Platform/WindowlessNaClApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::WindowlessNaClApplication
+ * @brief Class @ref Magnum::Platform::WindowlessNaClApplication
  */
 
 #include <string>
@@ -50,21 +50,31 @@ namespace Magnum { namespace Platform {
 /** @nosubgrouping
 @brief Windowless NaCl application
 
-Application running in [Google Chrome Native Client](https://developers.google.com/native-client/).
+Application for offscreen rendering running in
+[Google Chrome Native Client](https://developers.google.com/native-client/).
 See @ref platform for brief introduction.
 
+This application library is available only in @ref CORRADE_TARGET_NACL "Native Client".
+It is built if `WITH_WINDOWLESSNACLAPPLICATION` is enabled in CMake. To use it,
+you need to request `%WindowlessNaClApplication` component in CMake, add
+`${MAGNUM_WINDOWLESSNACLAPPLICATION_INCLUDE_DIRS}` to include path and link to
+`${MAGNUM_WINDOWLESSNACLAPPLICATION_LIBRARIES}`. If no other windowless
+application is requested, you can also use generic
+`${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and
+`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting.
+
 @section WindowlessNaClApplication-usage Usage
 
-Place your code into exec(). The subclass must be then registered to NaCl API
+Place your code into @ref exec(). The subclass must be then registered to NaCl
-using MAGNUM_WINDOWLESSNACLAPPLICATION_MAIN() macro.
+API using @ref MAGNUM_WINDOWLESSNACLAPPLICATION_MAIN() macro.
 @code
-class MyApplication: public Magnum::Platform::WindowlessNaClApplication {
+class MyApplication: public Platform::WindowlessNaClApplication {
     // implement required methods...
 };
 MAGNUM_WINDOWLESSNACLAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::WindowlessApplication` and the macro is aliased to
 `MAGNUM_WINDOWLESSAPPLICATION_MAIN()` to simplify porting.
 

src/Platform/XEglApplication.h

@@ -25,7 +25,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Platform::XEglApplication
+ * @brief Class @ref Magnum::Platform::XEglApplication
  */
 
 #include "Platform/AbstractXApplication.h"
@@ -35,21 +35,32 @@ namespace Magnum { namespace Platform {
 /**
 @brief X/EGL application
 
-Uses EglContextHandler. See @ref platform for brief introduction.
+Application using pure X11 and EGL. Supports keyboard and mouse handling. See
+@ref platform for brief introduction.
+
+This application library is available on both desktop OpenGL and
+@ref MAGNUM_TARGET_GLES "OpenGL ES" on Linux. It depends on **X11** and **EGL**
+libraries and is built if `WITH_XEGLAPPLICATION` is enabled in CMake. To use
+it, you need to copy `FindEGL.cmake` from `modules/` directory in %Magnum
+source to `modules/` dir in your project (so CMake is able to find EGL),
+request `%XEglApplication` component in CMake, add `${MAGNUM_XEGLAPPLICATION_INCLUDE_DIRS}`
+to include path and link to `${MAGNUM_XEGLAPPLICATION_LIBRARIES}`.  If no other
+application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}`
+and `${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting.
 
 @section XEglApplication-usage Usage
 
-You need to implement at least drawEvent() and viewportEvent() to be able to
+You need to implement at least @ref drawEvent() and @ref viewportEvent() to be
-draw on the screen.  The subclass can be then used directly in `main()` - see
+able to draw on the screen.  The subclass can be then used directly in `main()`
-convenience macro MAGNUM_XEGLAPPLICATION_MAIN().
+-- see convenience macro @ref MAGNUM_XEGLAPPLICATION_MAIN().
 @code
-class MyApplication: public Magnum::Platform::XEglApplication {
+class MyApplication: public Platform::XEglApplication {
     // implement required methods...
 };
 MAGNUM_XEGLAPPLICATION_MAIN(MyApplication)
 @endcode
 
-If no other application header is included this class is also aliased to
+If no other application header is included, this class is also aliased to
 `Platform::Application` and the macro is aliased to `MAGNUM_APPLICATION_MAIN()`
 to simplify porting.
 */