summaryrefslogtreecommitdiff
path: root/Modules/CheckIncludeFile.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'Modules/CheckIncludeFile.cmake')
-rw-r--r--Modules/CheckIncludeFile.cmake32
1 files changed, 21 insertions, 11 deletions
diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake
index 8067e65ce7..2d0edf9ec6 100644
--- a/Modules/CheckIncludeFile.cmake
+++ b/Modules/CheckIncludeFile.cmake
@@ -1,19 +1,29 @@
-# - Check if the include file exists.
+#.rst:
+# CheckIncludeFile
+# ----------------
+#
+# macro which checks the include file exists.
+#
# CHECK_INCLUDE_FILE(INCLUDE VARIABLE)
-# - macro which checks the include file exists.
-# INCLUDE - name of include file
-# VARIABLE - variable to return result
#
-# an optional third argument is the CFlags to add to the compile line
-# or you can use CMAKE_REQUIRED_FLAGS
+# ::
+#
+# INCLUDE - name of include file
+# VARIABLE - variable to return result
+#
+#
+#
+# an optional third argument is the CFlags to add to the compile line or
+# you can use CMAKE_REQUIRED_FLAGS
#
-# The following variables may be set before calling this macro to
-# modify the way the check is run:
+# The following variables may be set before calling this macro to modify
+# the way the check is run:
#
-# CMAKE_REQUIRED_FLAGS = string of compile command line flags
-# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
-# CMAKE_REQUIRED_INCLUDES = list of include directories
+# ::
#
+# CMAKE_REQUIRED_FLAGS = string of compile command line flags
+# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
+# CMAKE_REQUIRED_INCLUDES = list of include directories
#=============================================================================
# Copyright 2002-2009 Kitware, Inc.