diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/FindosgFX.cmake | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | CMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2 | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Modules/FindosgFX.cmake')
| -rw-r--r-- | Modules/FindosgFX.cmake | 52 |
1 files changed, 28 insertions, 24 deletions
diff --git a/Modules/FindosgFX.cmake b/Modules/FindosgFX.cmake index 1f1d59f..7b2cb76 100644 --- a/Modules/FindosgFX.cmake +++ b/Modules/FindosgFX.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgFX -# This module defines -# -# OSGFX_FOUND - Was osgFX found? -# OSGFX_INCLUDE_DIR - Where to find the headers -# OSGFX_LIBRARIES - The libraries to link against for the osgFX (use this) -# -# OSGFX_LIBRARY - The osgFX library -# OSGFX_LIBRARY_DEBUG - The osgFX debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgFX +# --------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgFX This module defines +# +# OSGFX_FOUND - Was osgFX found? OSGFX_INCLUDE_DIR - Where to find the +# headers OSGFX_LIBRARIES - The libraries to link against for the osgFX +# (use this) +# +# OSGFX_LIBRARY - The osgFX library OSGFX_LIBRARY_DEBUG - The osgFX +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. |