From b9ca288b6941ccf0b1db21375843faf4a10b6211 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 31 Oct 2013 11:52:53 +0100 Subject: [PATCH] doc: minor formatting changes. --- doc/building.dox | 58 +++++++++++++++++----------------- doc/cmake.dox | 68 ++++++++++++++++++++-------------------- modules/FindMagnum.cmake | 2 +- 3 files changed, 64 insertions(+), 64 deletions(-) diff --git a/doc/building.dox b/doc/building.dox index 800f3c569..2866f5161 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -140,40 +140,40 @@ By default the engine is built with nearly everything except Audio library and application libraries (see below). Using `WITH_*` CMake parameters you can specify which parts will be built and which not: - - `WITH_AUDIO` - Audio library. Depends on **OpenAL** library, not built by - default. - - `WITH_DEBUGTOOLS` - DebugTools library. Enables also building of MeshTools, - Primitives, SceneGraph, Shaders and Shapes libraries. - - `WITH_MESHTOOLS` - MeshTools library. Enabled automatically if `WITH_DEBUGTOOLS` - is enabled. - - `WITH_PRIMITIVES` - Primitives library. Enabled automatically if `WITH_DEBUGTOOLS` - is enabled. - - `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if `WITH_DEBUGTOOLS` - or `WITH_SHAPES` is enabled. - - `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS` - is enabled. - - `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph library. - Enabled automatically if `WITH_DEBUGTOOLS` is enabled. - - `WITH_TEXT` - Text library. Enables also building of TextureTools library. - - `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if `WITH_TEXT` - or `WITH_DISTANCEFIELDCONVERTER` is enabled. - - `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about the - engine and OpenGL capabilities. - - `WITH_DISTANCEFIELDCONVERTER` - `magnum-distancefield` executable for - converting black&white images to distance field textures. Enables also - building of TextureTools library. +- `WITH_AUDIO` - Audio library. Depends on **OpenAL** library, not built by + default. +- `WITH_DEBUGTOOLS` - DebugTools library. Enables also building of MeshTools, + Primitives, SceneGraph, Shaders and Shapes libraries. +- `WITH_MESHTOOLS` - MeshTools library. Enabled automatically if + `WITH_DEBUGTOOLS` is enabled. +- `WITH_PRIMITIVES` - Primitives library. Enabled automatically if + `WITH_DEBUGTOOLS` is enabled. +- `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if + `WITH_DEBUGTOOLS` or `WITH_SHAPES` is enabled. +- `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS` + is enabled. +- `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph + library. Enabled automatically if `WITH_DEBUGTOOLS` is enabled. +- `WITH_TEXT` - Text library. Enables also building of TextureTools library. +- `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if + `WITH_TEXT` or `WITH_DISTANCEFIELDCONVERTER` is enabled. +- `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about + the engine and OpenGL capabilities. +- `WITH_DISTANCEFIELDCONVERTER` - `magnum-distancefield` executable for + converting black&white images to distance field textures. Enables also + building of TextureTools library. None of the @ref Platform "application libraries" is built by default (and you need at least one). Choose the one which suits your requirements and your platform best: -- `WITH_GLUTAPPLICATION` - @ref Platform::GlutApplication "GlutApplication" -- `WITH_GLXAPPLICATION` - @ref Platform::GlxApplication "GlxApplication" -- `WITH_NACLAPPLICATION` - @ref Platform::NaClApplication "NaClApplication" -- `WITH_SDL2APPLICATION` - @ref Platform::Sdl2Application "Sdl2Application" -- `WITH_XEGLAPPLICATION` - @ref Platform::XEglApplication "XEglApplication" -- `WITH_WINDOWLESSGLXAPPLICATION` - @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" -- `WITH_WINDOWLESSNACLAPPLICATION` - @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication" +- `WITH_GLUTAPPLICATION` - @ref Platform::GlutApplication "GlutApplication" +- `WITH_GLXAPPLICATION` - @ref Platform::GlxApplication "GlxApplication" +- `WITH_NACLAPPLICATION` - @ref Platform::NaClApplication "NaClApplication" +- `WITH_SDL2APPLICATION` - @ref Platform::Sdl2Application "Sdl2Application" +- `WITH_XEGLAPPLICATION` - @ref Platform::XEglApplication "XEglApplication" +- `WITH_WINDOWLESSGLXAPPLICATION` - @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" +- `WITH_WINDOWLESSNACLAPPLICATION` - @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication" Note that [each namespace](namespaces.html) and all @ref Platform libraries contain more detailed information about dependencies, availability on diff --git a/doc/cmake.dox b/doc/cmake.dox index fbea44ae0..5fc320b9d 100644 --- a/doc/cmake.dox +++ b/doc/cmake.dox @@ -40,37 +40,37 @@ Basic usage is: This command tries to find base %Magnum library and then defines these variables: -- `MAGNUM_FOUND` -- Whether the library was found -- `MAGNUM_LIBRARIES` -- %Magnum library and dependent libraries -- `MAGNUM_INCLUDE_DIRS` -- Root include dir and include dirs of dependencies -- `MAGNUM_PLUGINS_FONT_DIR` -- Directory with font plugins -- `MAGNUM_PLUGINS_IMPORTER_DIR` -- Directory with importer plugins +- `MAGNUM_FOUND` -- Whether the library was found +- `MAGNUM_LIBRARIES` -- %Magnum library and dependent libraries +- `MAGNUM_INCLUDE_DIRS` -- Root include dir and include dirs of dependencies +- `MAGNUM_PLUGINS_FONT_DIR` -- Directory with font plugins +- `MAGNUM_PLUGINS_IMPORTER_DIR` -- Directory with importer plugins However, this command will try to find only the base library, not the optional 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`, - `%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 +- `%Audio` -- Audio library +- `%DebugTools` -- 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 Platform namespace is split into more components: -- `%GlutApplication` -- @ref Platform::GlutApplication "GlutApplication" -- `%GlxApplication` -- @ref Platform::GlxApplication "GlxApplication" -- `%NaClApplication` -- @ref Platform::NaClApplication "NaClApplication" -- `%Sdl2Application` -- @ref Platform::Sdl2Application "Sdl2Application" -- `%XEglApplication` -- @ref Platform::XEglApplication "XEglApplication" -- `%WindowlessNaClApplication` -- @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication" -- `%WindowlessGlxApplication` -- @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" +- `%GlutApplication` -- @ref Platform::GlutApplication "GlutApplication" +- `%GlxApplication` -- @ref Platform::GlxApplication "GlxApplication" +- `%NaClApplication` -- @ref Platform::NaClApplication "NaClApplication" +- `%Sdl2Application` -- @ref Platform::Sdl2Application "Sdl2Application" +- `%XEglApplication` -- @ref Platform::XEglApplication "XEglApplication" +- `%WindowlessGlxApplication` -- @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" +- `%WindowlessNaClApplication` -- @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication" Note that [each namespace](namespaces.html) and all @ref Platform libraries contain more detailed information about dependencies, availability on @@ -83,9 +83,9 @@ Example usage with specifying additional components is: For each component is then defined: -- `MAGNUM_*_FOUND` -- Whether the component was found -- `MAGNUM_*_LIBRARIES` -- Component library and dependent libraries -- `MAGNUM_*_INCLUDE_DIRS` -- Include dirs of module dependencies +- `MAGNUM_*_FOUND` -- Whether the component was found +- `MAGNUM_*_LIBRARIES` -- Component library and dependent libraries +- `MAGNUM_*_INCLUDE_DIRS` -- Include dirs of module dependencies If exactly one `*Application` or exactly one `Windowless*Application` component is requested and found, its libraries and include dirs are available in @@ -96,15 +96,15 @@ convenience aliases `MAGNUM_APPLICATION_LIBRARIES` / Features of found %Magnum library are exposed in these CMake variables, they are also available as preprocessor variables if including Magnum.h: -- `MAGNUM_BUILD_DEPRECATED` -- Defined if compiled with deprecated APIs - included -- `MAGNUM_BUILD_STATIC` -- Defined if built as static libraries. Default are - shared libraries. -- `MAGNUM_TARGET_GLES` -- Defined if compiled for OpenGL ES -- `MAGNUM_TARGET_GLES2` -- Defined if compiled for OpenGL ES 2.0 -- `MAGNUM_TARGET_GLES3` -- Defined if compiled for OpenGL ES 3.0 -- `MAGNUM_TARGET_DESKTOP_GLES` -- Defined if compiled with OpenGL ES emulation - on desktop OpenGL +- `MAGNUM_BUILD_DEPRECATED` -- Defined if compiled with deprecated APIs + included +- `MAGNUM_BUILD_STATIC` -- Defined if built as static libraries. Default are + shared libraries. +- `MAGNUM_TARGET_GLES` -- Defined if compiled for OpenGL ES +- `MAGNUM_TARGET_GLES2` -- Defined if compiled for OpenGL ES 2.0 +- `MAGNUM_TARGET_GLES3` -- Defined if compiled for OpenGL ES 3.0 +- `MAGNUM_TARGET_DESKTOP_GLES` -- Defined if compiled with OpenGL ES + emulation on desktop OpenGL %Corrade library provides also its own set of CMake macros and variables, see @ref corrade-cmake "its documentation" for more information. diff --git a/modules/FindMagnum.cmake b/modules/FindMagnum.cmake index c6223bf79..5670489d8 100644 --- a/modules/FindMagnum.cmake +++ b/modules/FindMagnum.cmake @@ -35,8 +35,8 @@ # NaClApplication - NaCl application # Sdl2Application - SDL2 application # XEglApplication - X/EGL application -# WindowlessNaClApplication - Windowless NaCl application # WindowlessGlxApplication - Windowless GLX application +# WindowlessNaClApplication - Windowless NaCl application # Example usage with specifying additional components is: # find_package(Magnum [REQUIRED|COMPONENTS] # MeshTools Primitives GlutApplication)