FindProducer: Improve documentation formatting

This commit is contained in:
權少
2023-09-18 09:08:46 -04:00
committed by Brad King
parent b35c17b202
commit 3cf5f4af54

View File

@@ -5,8 +5,6 @@
FindProducer
------------
Though Producer isn't directly part of OpenSceneGraph, its primary
user is OSG so I consider this part of the Findosg* suite used to find
OpenSceneGraph components. You'll notice that I accept OSGDIR as an
@@ -17,19 +15,25 @@ must also opt into OpenGL (and OpenThreads?) 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).
:module:`FindOpenGL` 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
use the :module:`FindOpenSceneGraph` instead of the Findosg*.cmake
modules.
Locate Producer This module defines PRODUCER_LIBRARY PRODUCER_FOUND,
if false, do not try to link to Producer PRODUCER_INCLUDE_DIR, where
to find the headers
Locate Producer This module defines:
$PRODUCER_DIR is an environment variable that would correspond to the
./configure --prefix=$PRODUCER_DIR used in building osg.
``PRODUCER_LIBRARY``
Created by Eric Wing.
``PRODUCER_FOUND``
if false, do not try to link to Producer
``PRODUCER_INCLUDE_DIR``
where to find the headers
``$PRODUCER_DIR`` is an environment variable that would correspond to::
./configure --prefix=$PRODUCER_DIR
used in building osg.
#]=======================================================================]
# Header files are presumed to be included like