diff options
| author | 權少 <ljqican@163.com> | 2023-09-12 16:36:13 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-09-12 16:54:39 (GMT) |
| commit | 90c3357c670885cf3ee1254dc0d62329e8315e82 (patch) | |
| tree | c806c69b983e557a267a4c2d777dbbb8dd545f8d /Modules/Findosg.cmake | |
| parent | 976659c8462e10ea545f1745b78f68bac9014a61 (diff) | |
| download | CMake-90c3357c670885cf3ee1254dc0d62329e8315e82.zip CMake-90c3357c670885cf3ee1254dc0d62329e8315e82.tar.gz CMake-90c3357c670885cf3ee1254dc0d62329e8315e82.tar.bz2 | |
Findosg*: Improve documentation formatting
Add reST markup for inline literals, definition lists, and notes.
Diffstat (limited to 'Modules/Findosg.cmake')
| -rw-r--r-- | Modules/Findosg.cmake | 30 |
1 files changed, 19 insertions, 11 deletions
diff --git a/Modules/Findosg.cmake b/Modules/Findosg.cmake index c9daece..9e952c9 100644 --- a/Modules/Findosg.cmake +++ b/Modules/Findosg.cmake @@ -7,9 +7,10 @@ Findosg -NOTE: It is highly recommended that you use the new -FindOpenSceneGraph.cmake introduced in CMake 2.6.3 and not use this -Find module directly. +.. note:: + It is highly recommended that you use the new + :module:`FindOpenSceneGraph` introduced in CMake 2.6.3 and not use this + Find module directly. This is part of the ``Findosg*`` suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each @@ -22,17 +23,24 @@ work with your system as an example). If you want to use a more convenient module that includes everything, use the :module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules. -Locate osg This module defines +Locate osg This module defines: -OSG_FOUND - Was the Osg found? OSG_INCLUDE_DIR - Where to find the -headers OSG_LIBRARIES - The libraries to link against for the OSG (use -this) +``OSG_FOUND`` + Was the Osg found? +``OSG_INCLUDE_DIR`` + Where to find theheaders +``OSG_LIBRARIES`` + The libraries to link against for the OSG (use this) +``OSG_LIBRARY`` + The OSG library +``OSG_LIBRARY_DEBUG`` + The OSG debug library -OSG_LIBRARY - The OSG library OSG_LIBRARY_DEBUG - The OSG debug -library +``$OSGDIR`` is an environment variable that would correspond to:: -$OSGDIR is an environment variable that would correspond to the -./configure --prefix=$OSGDIR used in building osg. + ./configure --prefix=$OSGDIR + +used in building osg. Created by Eric Wing. #]=======================================================================] |