Browse Source

FindPerl: Improve documentation formatting

Also modernize some wording.
polarbub 2 years ago
parent
commit
dc3f264f9d
1 changed files with 11 additions and 6 deletions
  1. 11 6
      Modules/FindPerl.cmake

+ 11 - 6
Modules/FindPerl.cmake

@@ -5,15 +5,20 @@
 FindPerl
 --------
 
-Find perl
+Find a Perl interpreter.
 
-this module looks for Perl
+This module defines the following variables:
 
-::
+``PERL_EXECUTABLE``
+  The full path to Perl.
 
-  PERL_EXECUTABLE     - the full path to perl
-  PERL_FOUND          - If false, don't attempt to use perl.
-  PERL_VERSION_STRING - version of perl found (since CMake 2.8.8)
+``PERL_FOUND``
+  True if the executable was found perl.
+
+``PERL_VERSION_STRING``
+  .. versionadded:: 2.8.8
+
+  The version of perl found.
 #]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/FindCygwin.cmake)