Browse Source

Merge topic 'patch-FindBullet'

903048a2e8 FindBullet: Update documentation

Acked-by: Kitware Robot <[email protected]>
Merge-request: !10518
Brad King 9 months ago
parent
commit
72d42a607a
1 changed files with 24 additions and 20 deletions
  1. 24 20
      Modules/FindBullet.cmake

+ 24 - 20
Modules/FindBullet.cmake

@@ -5,35 +5,39 @@
 FindBullet
 ----------
 
-Try to find the Bullet physics engine
+Finds the Bullet physics engine.
 
+Result Variables
+^^^^^^^^^^^^^^^^
 
+This module defines the following variables:
 
-::
+``Bullet_FOUND``
+  Boolean true if Bullet was found.  For backward compatibility, the
+  ``BULLET_FOUND`` variable is also set to the same value.
+``BULLET_INCLUDE_DIRS``
+  The Bullet include directories.
+``BULLET_LIBRARIES``
+  Libraries needed to link to Bullet.  By default, all Bullet components
+  (Dynamics, Collision, LinearMath, and SoftBody) are added.
 
-  This module defines the following variables
+Hints
+^^^^^
 
+This module accepts the following variables:
 
+``BULLET_ROOT``
+  Can be set to Bullet install path or Windows build path to specify where to
+  find Bullet.
 
-::
+Examples
+^^^^^^^^
 
-  BULLET_FOUND - Was bullet found
-  BULLET_INCLUDE_DIRS - the Bullet include directories
-  BULLET_LIBRARIES - Link to this, by default it includes
-                     all bullet components (Dynamics,
-                     Collision, LinearMath, & SoftBody)
+Finding Bullet:
 
+.. code-block:: cmake
 
-
-::
-
-  This module accepts the following variables
-
-
-
-::
-
-  BULLET_ROOT - Can be set to bullet install path or Windows build path
+  find_package(Bullet)
 #]=======================================================================]
 
 macro(_FIND_BULLET_LIBRARY _var)
@@ -85,7 +89,7 @@ find_package_handle_standard_args(Bullet DEFAULT_MSG
     BULLET_SOFTBODY_LIBRARY BULLET_INCLUDE_DIR)
 
 set(BULLET_INCLUDE_DIRS ${BULLET_INCLUDE_DIR})
-if(BULLET_FOUND)
+if(Bullet_FOUND)
    _BULLET_APPEND_LIBRARIES(BULLET_LIBRARIES BULLET_DYNAMICS_LIBRARY)
    _BULLET_APPEND_LIBRARIES(BULLET_LIBRARIES BULLET_COLLISION_LIBRARY)
    _BULLET_APPEND_LIBRARIES(BULLET_LIBRARIES BULLET_MATH_LIBRARY)