From 3cf5f4af548a84e877f26a7053e6055bfa10c8ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=AC=8A=E5=B0=91?= Date: Mon, 18 Sep 2023 09:08:46 -0400 Subject: FindProducer: Improve documentation formatting --- Modules/FindProducer.cmake | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/Modules/FindProducer.cmake b/Modules/FindProducer.cmake index 65495b5..8a16e8a 100644 --- a/Modules/FindProducer.cmake +++ b/Modules/FindProducer.cmake @@ -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_LIBRARY`` + +``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:: -$PRODUCER_DIR is an environment variable that would correspond to the -./configure --prefix=$PRODUCER_DIR used in building osg. + ./configure --prefix=$PRODUCER_DIR -Created by Eric Wing. +used in building osg. #]=======================================================================] # Header files are presumed to be included like -- cgit v0.12