summaryrefslogtreecommitdiffstats
path: root/Modules/CheckCXXSourceCompiles.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 13:28:12 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-16 13:28:12 (GMT)
commitc49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch)
tree96102c69673467ce7b922697cd5f378511249201 /Modules/CheckCXXSourceCompiles.cmake
parent5029da5eac08171653a92b961c341f7ffcca3640 (diff)
parent7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff)
downloadCMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation a77e308 CPack: Replace #<type> markup with reStructuredText equivalent e7ca48f Help: Factor out cmake-generator-expressions manual page 97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication 8982161 Help: Factor out find_* command duplication 30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication bfe07aa Build Help documentation during CMake build using Sphinx 53ded59 Drop unused builtin documentation APIs 0c39a75 Drop the 'Full' field from cmDocumentationEntry e33d8d2 Drop builtin command documentation 399e9c4 Drop builtin property documentation 6035c04 get_property: Drop test for builtin property documentation 80a3273 Drop all documentation formatters except Usage b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents ec6df36 Teach --help-* options to load documentation from .rst files 25f2877 Add class cmRST to do basic reStructuredText processing ...
Diffstat (limited to 'Modules/CheckCXXSourceCompiles.cmake')
-rw-r--r--Modules/CheckCXXSourceCompiles.cmake31
1 files changed, 21 insertions, 10 deletions
diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake
index 734c083..c7ef5ec 100644
--- a/Modules/CheckCXXSourceCompiles.cmake
+++ b/Modules/CheckCXXSourceCompiles.cmake
@@ -1,15 +1,26 @@
-# - Check if given C++ source compiles and links into an executable
+#.rst:
+# CheckCXXSourceCompiles
+# ----------------------
+#
+# Check if given C++ source compiles and links into an executable
+#
# CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])
-# <code> - source code to try to compile, must define 'main'
-# <var> - variable to store whether the source code compiled
-# <fail-regex> - fail if test output matches this regex
-# 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_LIBRARIES = list of libraries to link
+# ::
+#
+# <code> - source code to try to compile, must define 'main'
+# <var> - variable to store whether the source code compiled
+# <fail-regex> - fail if test output matches this regex
+#
+# 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_LIBRARIES = list of libraries to link
#=============================================================================
# Copyright 2005-2009 Kitware, Inc.