mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-05 14:18:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'update-module-document'

Browse Source 
3a54ee8cd5 FindQuickTime: Improve documentation formatting
3cf5f4af54 FindProducer: Improve documentation formatting
b35c17b202 FindPhysFS: Improve documentation formatting

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8812
This commit is contained in:
Brad King
2023-09-19 13:09:32 +00:00
committed by Kitware Robot
parent 7a88ff9487 3a54ee8cd5
commit 3d3c49cd9c
3 changed files with 32 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Modules/FindPhysFS.cmake
View File

@@ -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

24
Modules/FindProducer.cmake
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

14
Modules/FindQuickTime.cmake
View File

@@ -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