From b35c17b20223a6036e9f2b5442510cb6f56eead1 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: FindPhysFS: Improve documentation formatting --- Modules/FindPhysFS.cmake | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/Modules/FindPhysFS.cmake b/Modules/FindPhysFS.cmake index a32f83a..19e5ba9 100644 --- a/Modules/FindPhysFS.cmake +++ b/Modules/FindPhysFS.cmake @@ -5,16 +5,20 @@ FindPhysFS ---------- +Locate PhysFS library This module defines: +``PHYSFS_LIBRARY`` + the name of the library to link against +``PHYSFS_FOUND`` + if false, do not try to link to PHYSFS +``PHYSFS_INCLUDE_DIR`` + where to find physfs.h -Locate PhysFS library This module defines PHYSFS_LIBRARY, the name of -the library to link against PHYSFS_FOUND, if false, do not try to link -to PHYSFS PHYSFS_INCLUDE_DIR, where to find physfs.h +``$PHYSFSDIR`` is an environment variable that would correspond to:: -$PHYSFSDIR is an environment variable that would correspond to the -./configure --prefix=$PHYSFSDIR used in building PHYSFS. + ./configure --prefix=$PHYSFSDIR -Created by Eric Wing. +used in building PHYSFS. #]=======================================================================] find_path(PHYSFS_INCLUDE_DIR physfs.h -- cgit v0.12 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 From 3a54ee8cd54f93bc8920089b5fa6371931935f26 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: FindQuickTime: Improve documentation formatting --- Modules/FindQuickTime.cmake | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Modules/FindQuickTime.cmake b/Modules/FindQuickTime.cmake index 107486d..89be2a6 100644 --- a/Modules/FindQuickTime.cmake +++ b/Modules/FindQuickTime.cmake @@ -5,16 +5,18 @@ FindQuickTime ------------- +Locate QuickTime This module defines: +``QUICKTIME_LIBRARY`` -Locate QuickTime This module defines QUICKTIME_LIBRARY -QUICKTIME_FOUND, if false, do not try to link to gdal -QUICKTIME_INCLUDE_DIR, where to find the headers +``QUICKTIME_FOUND`` + if false, do not try to link to gdal +``QUICKTIME_INCLUDE_DIR`` + where to find the headers -$QUICKTIME_DIR is an environment variable that would correspond to the -./configure --prefix=$QUICKTIME_DIR +``$QUICKTIME_DIR`` is an environment variable that would correspond to:: -Created by Eric Wing. + ./configure --prefix=$QUICKTIME_DIR #]=======================================================================] find_path(QUICKTIME_INCLUDE_DIR QuickTime/QuickTime.h QuickTime.h -- cgit v0.12