Browse Source

Improved formatting of FindMagnum.cmake documentation.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
e3b21c57db
  1. 45
      modules/FindMagnum.cmake

45
modules/FindMagnum.cmake

@ -1,56 +1,51 @@
# - Find Magnum # - Find Magnum
# #
# Basic usage: # Basic usage:
#
# find_package(Magnum [REQUIRED]) # find_package(Magnum [REQUIRED])
#
# This command tries to find Magnum library and then defines: # This command tries to find Magnum library and then defines:
#
# MAGNUM_FOUND - Whether the library was found # MAGNUM_FOUND - Whether the library was found
# MAGNUM_TARGET_GLES - Defined if Magnum was built for OpenGL ES, # MAGNUM_TARGET_GLES - Defined if Magnum was built for OpenGL
# slightly reducing feature count. The same variable is also #defined in # ES, slightly reducing feature count. The same variable is also
# Magnum headers. # #defined in Magnum headers.
# MAGNUM_LIBRARIES - Magnum library and dependent libraries # MAGNUM_LIBRARIES - Magnum library and dependent libraries
# MAGNUM_INCLUDE_DIRS - Root include dir and include dirs of # MAGNUM_INCLUDE_DIRS - Root include dir and include dirs of
# dependencies # dependencies
# MAGNUM_PLUGINS_IMPORTER_DIR - Directory with importer plugins # MAGNUM_PLUGINS_IMPORTER_DIR - Directory with importer plugins
#
# This command will try to find only the base library, not the optional # This command will try to find only the base library, not the optional
# components. The base library depends on Corrade, OpenGL and GLEW libraries. # components. The base library depends on Corrade, OpenGL and GLEW
# Additional dependencies are specified by the components. The optional # libraries. Additional dependencies are specified by the components. The
# components are: # optional components are:
#
# MeshTools - MeshTools library # MeshTools - MeshTools library
# Physics - Physics library # Physics - Physics library
# Primitives - Library with stock geometric primitives (static) # Primitives - Library with stock geometric primitives (static)
# Shaders - Library with stock shaders # Shaders - Library with stock shaders
#
# EglContext - EGL context (depends on EGL and X11 libraries) # EglContext - EGL context (depends on EGL and X11 libraries)
# GlutContext - GLUT context (depends on GLUT library) # GlutContext - GLUT context (depends on GLUT library)
# Sdl2Context - SDL2 context (depends on SDL2 library) # Sdl2Context - SDL2 context (depends on SDL2 library)
#
# Example usage with specifying additional components is: # Example usage with specifying additional components is:
# # find_package(Magnum [REQUIRED|COMPONENTS]
# find_package(Magnum [REQUIRED|COMPONENTS] MeshTools Primitives GlutContext) # MeshTools Primitives GlutContext)
#
# For each component is then defined: # For each component is then defined:
#
# MAGNUM_*_FOUND - Whether the component was found # MAGNUM_*_FOUND - Whether the component was found
# MAGNUM_*_LIBRARIES - Component library and dependent libraries # MAGNUM_*_LIBRARIES - Component library and dependent libraries
# MAGNUM_*_INCLUDE_DIRS - Include dirs of module dependencies # MAGNUM_*_INCLUDE_DIRS - Include dirs of module dependencies
# #
# Additionally these variables are defined for internal usage: # Additionally these variables are defined for internal usage:
# # MAGNUM_INCLUDE_DIR - Root include dir (w/o
# MAGNUM_INCLUDE_DIR - Root include dir (w/o dependencies) # dependencies)
# MAGNUM_LIBRARY - Magnum library (w/o dependencies) # MAGNUM_LIBRARY - Magnum library (w/o
# MAGNUM_*_LIBRARY - Component libraries (w/o dependencies) # dependencies)
# # MAGNUM_*_LIBRARY - Component libraries (w/o
# dependencies)
# MAGNUM_LIBRARY_INSTALL_DIR - Library installation directory # MAGNUM_LIBRARY_INSTALL_DIR - Library installation directory
# MAGNUM_PLUGINS_INSTALL_DIR - Plugin installation directory # MAGNUM_PLUGINS_INSTALL_DIR - Plugin installation directory
# MAGNUM_PLUGINS_IMPORTER_INSTALL_DIR - Importer plugin installation directory # MAGNUM_PLUGINS_IMPORTER_INSTALL_DIR - Importer plugin installation
# MAGNUM_CMAKE_MODULE_INSTALL_DIR - Installation dir for CMake modules # directory
# MAGNUM_CMAKE_MODULE_INSTALL_DIR - Installation dir for CMake
# modules
# MAGNUM_INCLUDE_INSTALL_DIR - Header installation directory # MAGNUM_INCLUDE_INSTALL_DIR - Header installation directory
# MAGNUM_PLUGINS_INCLUDE_INSTALL_DIR - Plugin header installation directory # MAGNUM_PLUGINS_INCLUDE_INSTALL_DIR - Plugin header installation
# directory
# #
# Dependencies # Dependencies

Loading…
Cancel
Save