summaryrefslogtreecommitdiff
path: root/Modules/FindOpenSceneGraph.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 11:17:36 -0400
committerBrad King <brad.king@kitware.com>2013-10-15 14:12:03 -0400
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/FindOpenSceneGraph.cmake
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadcmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
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/FindOpenSceneGraph.cmake')
-rw-r--r--Modules/FindOpenSceneGraph.cmake109
1 files changed, 76 insertions, 33 deletions
diff --git a/Modules/FindOpenSceneGraph.cmake b/Modules/FindOpenSceneGraph.cmake
index 7affca8a21..7bbd7536a0 100644
--- a/Modules/FindOpenSceneGraph.cmake
+++ b/Modules/FindOpenSceneGraph.cmake
@@ -1,55 +1,98 @@
-# - Find OpenSceneGraph
-# This module searches for the OpenSceneGraph core "osg" library as well as
-# OpenThreads, and whatever additional COMPONENTS (nodekits) that you specify.
-# See http://www.openscenegraph.org
+#.rst:
+# FindOpenSceneGraph
+# ------------------
#
-# 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.
+# Find OpenSceneGraph
#
-#==================================
+# This module searches for the OpenSceneGraph core "osg" library as well
+# as OpenThreads, and whatever additional COMPONENTS (nodekits) that you
+# specify.
+#
+# ::
+#
+# See http://www.openscenegraph.org
+#
+#
+#
+# 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.
+#
+# ==================================
#
# This module accepts the following variables (note mixed case)
#
-# OpenSceneGraph_DEBUG - Enable debugging output
+# ::
+#
+# OpenSceneGraph_DEBUG - Enable debugging output
+#
+#
+#
+# ::
+#
+# OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced
+# automatically
+#
+#
+#
+# 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).
+#
+# ::
#
-# OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced
-# automatically
+# <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
+# OSG_DIR
+# OSGDIR
+# OSG_ROOT
#
-# 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).
#
-# <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
-# OSG_DIR
-# OSGDIR
-# OSG_ROOT
#
-# [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.
+# [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.
#
# This module defines the following output variables:
#
-# OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found?
+# ::
+#
+# OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found?
+#
+#
+#
+# ::
+#
+# OPENSCENEGRAPH_VERSION - The version of the OSG which was found
+#
+#
+#
+# ::
+#
+# OPENSCENEGRAPH_INCLUDE_DIRS - Where to find the headers
+#
+#
+#
+# ::
+#
+# OPENSCENEGRAPH_LIBRARIES - The OSG libraries
+#
+#
#
-# OPENSCENEGRAPH_VERSION - The version of the OSG which was found
+# ================================== Example Usage:
#
-# OPENSCENEGRAPH_INCLUDE_DIRS - Where to find the headers
+# ::
#
-# OPENSCENEGRAPH_LIBRARIES - The OSG libraries
+# find_package(OpenSceneGraph 2.0.0 REQUIRED osgDB osgUtil)
+# # libOpenThreads & libosg automatically searched
+# include_directories(${OPENSCENEGRAPH_INCLUDE_DIRS})
#
-#==================================
-# Example Usage:
#
-# find_package(OpenSceneGraph 2.0.0 REQUIRED osgDB osgUtil)
-# # libOpenThreads & libosg automatically searched
-# include_directories(${OPENSCENEGRAPH_INCLUDE_DIRS})
#
-# add_executable(foo foo.cc)
-# target_link_libraries(foo ${OPENSCENEGRAPH_LIBRARIES})
+# ::
#
+# add_executable(foo foo.cc)
+# target_link_libraries(foo ${OPENSCENEGRAPH_LIBRARIES})
#=============================================================================
# Copyright 2009 Kitware, Inc.