diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-12 14:37:05 (GMT) |
|---|---|---|
| committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-23 08:39:34 (GMT) |
| commit | cb811d11cee1e2873cc2bf506cd081769e894ac3 (patch) | |
| tree | 6fa97b0fb931bfbc6faaf866c3e745a0fd5ea430 /Modules/FindOpenSceneGraph.cmake | |
| parent | 4ff7706f2d7eaaffe3970da5f77d18f67771a4a8 (diff) | |
| download | CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.zip CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.gz CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.bz2 | |
Help: Improve description of modules
Diffstat (limited to 'Modules/FindOpenSceneGraph.cmake')
| -rw-r--r-- | Modules/FindOpenSceneGraph.cmake | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/Modules/FindOpenSceneGraph.cmake b/Modules/FindOpenSceneGraph.cmake index 6f7d3c8..27909bc 100644 --- a/Modules/FindOpenSceneGraph.cmake +++ b/Modules/FindOpenSceneGraph.cmake @@ -5,11 +5,11 @@ FindOpenSceneGraph ------------------ -Find OpenSceneGraph +Find OpenSceneGraph (3D graphics application programming interface) This module searches for the OpenSceneGraph core "osg" library as well -as OpenThreads, and whatever additional COMPONENTS (nodekits) that you -specify. +as :module:`FindOpenThreads`, and whatever additional ``COMPONENTS`` +(nodekits) that you specify. :: @@ -17,10 +17,11 @@ specify. -NOTE: To use this module effectively you must either require CMake >= -2.6.3 with cmake_minimum_required(VERSION 2.6.3) or download and place -FindOpenThreads.cmake, Findosg_functions.cmake, Findosg.cmake, and -Find<etc>.cmake files into your CMAKE_MODULE_PATH. +NOTE: To use this module effectively you must either require ``CMake >= +2.6.3`` with :command:`cmake_minimum_required(VERSION 2.6.3)` or download +and place :module:`FindOpenThreads`, :module:`Findosg` functions, +:module:`Findosg` and ``Find<etc>.cmake`` files into your +:variable:`CMAKE_MODULE_PATH`. ================================== @@ -40,11 +41,12 @@ This module accepts the following variables (note mixed case) The following environment variables are also respected for finding the -OSG and it's various components. CMAKE_PREFIX_PATH can also be used -for this (see find_library() CMake documentation). +OSG and it's various components. :variable:`CMAKE_PREFIX_PATH` can also be +used for this (see :command:`find_library` CMake documentation). ``<MODULE>_DIR`` - (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file) + (where ``MODULE`` is of the form "OSGVOLUME" and there is + a :module:`FindosgVolume`.cmake` file) ``OSG_DIR`` .. ``OSGDIR`` @@ -53,7 +55,7 @@ for this (see find_library() CMake documentation). .. -[CMake 2.8.10]: The CMake variable OSG_DIR can now be used as well to +[CMake 2.8.10]: The CMake variable ``OSG_DIR`` can now be used as well to influence detection, instead of needing to specify an environment variable. |