Findosg*: Improve documentation formatting

Add reST markup for inline literals, definition lists, and notes.
stage/master/nightly/2023/09/13
權少 2023-09-12 12:36:13 -04:00 committed by Brad King
parent 976659c846
commit 90c3357c67
20 changed files with 276 additions and 151 deletions

View File

@ -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.
#]=======================================================================]

View File

@ -18,18 +18,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 osgAnimation This module defines
Locate osgAnimation This module defines:
OSGANIMATION_FOUND - Was osgAnimation found? OSGANIMATION_INCLUDE_DIR
- Where to find the headers OSGANIMATION_LIBRARIES - The libraries to
link against for the OSG (use this)
``OSGANIMATION_FOUND``
Was osgAnimation found?
``OSGANIMATION_INCLUDE_DIR``
Where to find the headers
``OSGANIMATION_LIBRARIES``
The libraries to link against for the OSG (use this)
``OSGANIMATION_LIBRARY``
The OSG library
``OSGANIMATION_LIBRARY_DEBUG``
The OSG debug library
OSGANIMATION_LIBRARY - The OSG library OSGANIMATION_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.
#]=======================================================================]

View File

@ -37,7 +37,9 @@ Locate osgDB This module defines:
``$OSGDIR`` is an environment variable that would correspond to::
./configure --prefix=$OSGDIR used in building osg.
./configure --prefix=$OSGDIR
used in building osg.
#]=======================================================================]

View File

@ -18,17 +18,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 osgFX This module defines
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_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
OSGFX_LIBRARY - The osgFX library OSGFX_LIBRARY_DEBUG - The osgFX
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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgGA This module defines
Locate osgGA This module defines:
OSGGA_FOUND - Was osgGA found? OSGGA_INCLUDE_DIR - Where to find the
headers OSGGA_LIBRARIES - The libraries to link against for the osgGA
(use this)
``OSGGA_FOUND``
Was osgGA found?
``OSGGA_INCLUDE_DIR``
Where to find the headers
``OSGGA_LIBRARIES``
The libraries to link against for the osgGA (use this)
``OSGGA_LIBRARY``
The osgGA library
``OSGGA_LIBRARY_DEBUG``
The osgGA debug library
OSGGA_LIBRARY - The osgGA library OSGGA_LIBRARY_DEBUG - The osgGA
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.
#]=======================================================================]

View File

@ -18,18 +18,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 osgINTROSPECTION This module defines
Locate osgINTROSPECTION This module defines:
OSGINTROSPECTION_FOUND - Was osgIntrospection found?
OSGINTROSPECTION_INCLUDE_DIR - Where to find the headers
OSGINTROSPECTION_LIBRARIES - The libraries to link for
osgIntrospection (use this)
``OSGINTROSPECTION_FOUND``
Was osgIntrospection found?
``OSGINTROSPECTION_INCLUDE_DIR``
Where to find the headers
``OSGINTROSPECTION_LIBRARIES``
The libraries to link for osgIntrospection (use this)
``OSGINTROSPECTION_LIBRARY``
The osgIntrospection library
``OSGINTROSPECTION_LIBRARY_DEBUG``
The osgIntrospection debug library
OSGINTROSPECTION_LIBRARY - The osgIntrospection library
OSGINTROSPECTION_LIBRARY_DEBUG - The osgIntrospection 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.
#]=======================================================================]

View File

@ -18,18 +18,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 osgManipulator This module defines
Locate osgManipulator This module defines:
OSGMANIPULATOR_FOUND - Was osgManipulator found?
OSGMANIPULATOR_INCLUDE_DIR - Where to find the headers
OSGMANIPULATOR_LIBRARIES - The libraries to link for osgManipulator
(use this)
``OSGMANIPULATOR_FOUND``
Was osgManipulator found?
``OSGMANIPULATOR_INCLUDE_DIR``
Where to find the headers
``OSGMANIPULATOR_LIBRARIES``
The libraries to link for osgManipulator (use this)
``OSGMANIPULATOR_LIBRARY``
The osgManipulator library
``OSGMANIPULATOR_LIBRARY_DEBUG``
The osgManipulator debug library
OSGMANIPULATOR_LIBRARY - The osgManipulator library
OSGMANIPULATOR_LIBRARY_DEBUG - The osgManipulator 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgParticle This module defines
Locate osgParticle This module defines:
OSGPARTICLE_FOUND - Was osgParticle found? OSGPARTICLE_INCLUDE_DIR -
Where to find the headers OSGPARTICLE_LIBRARIES - The libraries to
link for osgParticle (use this)
``OSGPARTICLE_FOUND``
Was osgParticle found?
``OSGPARTICLE_INCLUDE_DIR``
Where to find the headers
``OSGPARTICLE_LIBRARIES``
The libraries to link for osgParticle (use this)
``OSGPARTICLE_LIBRARY``
The osgParticle library
``OSGPARTICLE_LIBRARY_DEBUG``
The osgParticle debug library
OSGPARTICLE_LIBRARY - The osgParticle library
OSGPARTICLE_LIBRARY_DEBUG - The osgParticle 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.
#]=======================================================================]

View File

@ -18,19 +18,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 osgPresentation This module defines
Locate osgPresentation This module defines:
OSGPRESENTATION_FOUND - Was osgPresentation found?
OSGPRESENTATION_INCLUDE_DIR - Where to find the headers
OSGPRESENTATION_LIBRARIES - The libraries to link for osgPresentation
(use this)
``OSGPRESENTATION_FOUND``
Was osgPresentation found?
``OSGPRESENTATION_INCLUDE_DIR``
Where to find the headers
``OSGPRESENTATION_LIBRARIES``
The libraries to link for osgPresentation (use this)
``OSGPRESENTATION_LIBRARY``
The osgPresentation library
``OSGPRESENTATION_LIBRARY_DEBUG``
The osgPresentation debug library
OSGPRESENTATION_LIBRARY - The osgPresentation library
OSGPRESENTATION_LIBRARY_DEBUG - The osgPresentation 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. Modified to work with osgPresentation by Robert
Osfield, January 2012.
#]=======================================================================]

View File

@ -18,17 +18,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 osgProducer This module defines
Locate osgProducer This module defines:
OSGPRODUCER_FOUND - Was osgProducer found? OSGPRODUCER_INCLUDE_DIR -
Where to find the headers OSGPRODUCER_LIBRARIES - The libraries to
link for osgProducer (use this)
``OSGPRODUCER_FOUND``
Was osgProducer found?
``OSGPRODUCER_INCLUDE_DIR``
Where to find the headers
``OSGPRODUCER_LIBRARIES``
The libraries to link for osgProducer (use this)
``OSGPRODUCER_LIBRARY``
The osgProducer library
``OSGPRODUCER_LIBRARY_DEBUG``
The osgProducer debug library
OSGPRODUCER_LIBRARY - The osgProducer library
OSGPRODUCER_LIBRARY_DEBUG - The osgProducer 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.
#]=======================================================================]

View File

@ -18,16 +18,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 osgQt This module defines
Locate osgQt This module defines:
OSGQT_FOUND - Was osgQt found? OSGQT_INCLUDE_DIR - Where to find the
headers OSGQT_LIBRARIES - The libraries to link for osgQt (use this)
``OSGQT_FOUND``
Was osgQt found?
``OSGQT_INCLUDE_DIR``
Where to find the headers
``OSGQT_LIBRARIES``
The libraries to link for osgQt (use this)
``OSGQT_LIBRARY``
The osgQt library
``OSGQT_LIBRARY_DEBUG``
The osgQt debug library
OSGQT_LIBRARY - The osgQt library OSGQT_LIBRARY_DEBUG - The osgQt
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. Modified to work with osgQt by Robert Osfield,
January 2012.

View File

@ -18,17 +18,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 osgShadow This module defines
Locate osgShadow This module defines:
OSGSHADOW_FOUND - Was osgShadow found? OSGSHADOW_INCLUDE_DIR - Where
to find the headers OSGSHADOW_LIBRARIES - The libraries to link for
osgShadow (use this)
``OSGSHADOW_FOUND``
Was osgShadow found?
``OSGSHADOW_INCLUDE_DIR``
Where to find the headers
``OSGSHADOW_LIBRARIES``
The libraries to link for osgShadow (use this)
``OSGSHADOW_LIBRARY``
The osgShadow library
``OSGSHADOW_LIBRARY_DEBUG``
The osgShadow debug library
OSGSHADOW_LIBRARY - The osgShadow library OSGSHADOW_LIBRARY_DEBUG -
The osgShadow 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgSim This module defines
Locate osgSim This module defines:
OSGSIM_FOUND - Was osgSim found? OSGSIM_INCLUDE_DIR - Where to find
the headers OSGSIM_LIBRARIES - The libraries to link for osgSim (use
this)
``OSGSIM_FOUND``
Was osgSim found?
``OSGSIM_INCLUDE_DIR``
Where to find the headers
``OSGSIM_LIBRARIES``
The libraries to link for osgSim (use this)
``OSGSIM_LIBRARY``
The osgSim library
``OSGSIM_LIBRARY_DEBUG``
The osgSim debug library
OSGSIM_LIBRARY - The osgSim library OSGSIM_LIBRARY_DEBUG - The osgSim
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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgTerrain This module defines
Locate osgTerrain This module defines:
OSGTERRAIN_FOUND - Was osgTerrain found? OSGTERRAIN_INCLUDE_DIR -
Where to find the headers OSGTERRAIN_LIBRARIES - The libraries to link
for osgTerrain (use this)
``OSGTERRAIN_FOUND``
Was osgTerrain found?
``OSGTERRAIN_INCLUDE_DIR``
Where to find the headers
``OSGTERRAIN_LIBRARIES``
The libraries to link for osgTerrain (use this)
``OSGTERRAIN_LIBRARY``
The osgTerrain library
``OSGTERRAIN_LIBRARY_DEBUG``
The osgTerrain debug library
OSGTERRAIN_LIBRARY - The osgTerrain library OSGTERRAIN_LIBRARY_DEBUG -
The osgTerrain 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgText This module defines
Locate osgText This module defines:
OSGTEXT_FOUND - Was osgText found? OSGTEXT_INCLUDE_DIR - Where to find
the headers OSGTEXT_LIBRARIES - The libraries to link for osgText (use
this)
``OSGTEXT_FOUND``
Was osgText found?
``OSGTEXT_INCLUDE_DIR``
Where to find the headers
``OSGTEXT_LIBRARIES``
The libraries to link for osgText (use this)
``OSGTEXT_LIBRARY``
The osgText library
``OSGTEXT_LIBRARY_DEBUG``
The osgText debug library
OSGTEXT_LIBRARY - The osgText library OSGTEXT_LIBRARY_DEBUG - The
osgText 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgUtil This module defines
Locate osgUtil This module defines:
OSGUTIL_FOUND - Was osgUtil found? OSGUTIL_INCLUDE_DIR - Where to find
the headers OSGUTIL_LIBRARIES - The libraries to link for osgUtil (use
this)
``OSGUTIL_FOUND``
Was osgUtil found?
``OSGUTIL_INCLUDE_DIR``
Where to find the headers
``OSGUTIL_LIBRARIES``
The libraries to link for osgUtil (use this)
``OSGUTIL_LIBRARY``
The osgUtil library
``OSGUTIL_LIBRARY_DEBUG``
The osgUtil debug library
OSGUTIL_LIBRARY - The osgUtil library OSGUTIL_LIBRARY_DEBUG - The
osgUtil 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgViewer This module defines
Locate osgViewer This module defines:
OSGVIEWER_FOUND - Was osgViewer found? OSGVIEWER_INCLUDE_DIR - Where
to find the headers OSGVIEWER_LIBRARIES - The libraries to link for
osgViewer (use this)
``OSGVIEWER_FOUND``
Was osgViewer found?
``OSGVIEWER_INCLUDE_DIR``
Where to find the headers
``OSGVIEWER_LIBRARIES``
The libraries to link for osgViewer (use this)
``OSGVIEWER_LIBRARY``
The osgViewer library
``OSGVIEWER_LIBRARY_DEBUG``
The osgViewer debug library
OSGVIEWER_LIBRARY - The osgViewer library OSGVIEWER_LIBRARY_DEBUG -
The osgViewer 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgVolume This module defines
Locate osgVolume This module defines:
OSGVOLUME_FOUND - Was osgVolume found? OSGVOLUME_INCLUDE_DIR - Where
to find the headers OSGVOLUME_LIBRARIES - The libraries to link for
osgVolume (use this)
``OSGVOLUME_FOUND``
Was osgVolume found?
``OSGVOLUME_INCLUDE_DIR``
Where to find the headers
``OSGVOLUME_LIBRARIES``
The libraries to link for osgVolume (use this)
``OSGVOLUME_LIBRARY``
The osgVolume library
``OSGVOLUME_LIBRARY_DEBUG``
The osgVolume debug library
OSGVOLUME_LIBRARY - The osgVolume library OSGVOLUME_LIBRARY_DEBUG -
The osgVolume 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.
#]=======================================================================]

View File

@ -18,17 +18,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 osgWidget This module defines
Locate osgWidget This module defines:
OSGWIDGET_FOUND - Was osgWidget found? OSGWIDGET_INCLUDE_DIR - Where
to find the headers OSGWIDGET_LIBRARIES - The libraries to link for
osgWidget (use this)
``OSGWIDGET_FOUND``
Was osgWidget found?
``OSGWIDGET_INCLUDE_DIR``
Where to find the headers
``OSGWIDGET_LIBRARIES``
The libraries to link for osgWidget (use this)
``OSGWIDGET_LIBRARY``
The osgWidget library
``OSGWIDGET_LIBRARY_DEBUG``
The osgWidget debug library
OSGWIDGET_LIBRARY - The osgWidget library OSGWIDGET_LIBRARY_DEBUG -
The osgWidget 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.
FindosgWidget.cmake tweaked from Findosg* suite as created by Eric
Wing.

View File

@ -10,7 +10,7 @@ Findosg_functions
This CMake file contains two macros to assist with searching for OSG
libraries and nodekits. Please see FindOpenSceneGraph.cmake for full
libraries and nodekits. Please see :module:`FindOpenSceneGraph` for full
documentation.
#]=======================================================================]