summaryrefslogtreecommitdiffstats
path: root/Modules/CheckCSourceRuns.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2009-09-17 19:28:51 (GMT)
committerBrad King <brad.king@kitware.com>2009-09-17 19:28:51 (GMT)
commit80af3ae35ddb2ff79d64d7183d901a95d05d661d (patch)
tree05b229db83f5f3caf7c792a06a680cf9478bc5c2 /Modules/CheckCSourceRuns.cmake
parent308e972412cdf3d8cde77b07527465e75888301a (diff)
downloadCMake-80af3ae35ddb2ff79d64d7183d901a95d05d661d.zip
CMake-80af3ae35ddb2ff79d64d7183d901a95d05d661d.tar.gz
CMake-80af3ae35ddb2ff79d64d7183d901a95d05d661d.tar.bz2
Cleanup generic compiler check macro documentation
This commit improves formatting and style of the documentation for the general-purpose compiler check macros: CHECK_C_COMPILER_FLAG CHECK_C_SOURCE_COMPILES CHECK_C_SOURCE_RUNS CHECK_CXX_COMPILER_FLAG CHECK_CXX_SOURCE_COMPILES CHECK_CXX_SOURCE_RUNS This sytle is more consistent with CMake command documentation. It also looks nicer in the generated documentation text files.
Diffstat (limited to 'Modules/CheckCSourceRuns.cmake')
-rw-r--r--Modules/CheckCSourceRuns.cmake11
1 files changed, 5 insertions, 6 deletions
diff --git a/Modules/CheckCSourceRuns.cmake b/Modules/CheckCSourceRuns.cmake
index 11d6251..3bd12e0 100644
--- a/Modules/CheckCSourceRuns.cmake
+++ b/Modules/CheckCSourceRuns.cmake
@@ -1,9 +1,8 @@
-# - Check if the C source code provided in the SOURCE argument compiles and runs.
-# CHECK_C_SOURCE_RUNS(SOURCE VAR)
-#
-# SOURCE - source code to try to compile
-# VAR - variable to store the result, 1 for success, empty for failure
-#
+# - Check if the given C source code compiles and runs.
+# CHECK_C_SOURCE_RUNS(<code> <var>)
+# <code> - source code to try to compile
+# <var> - variable to store the result
+# (1 for success, empty for failure)
# The following variables may be set before calling this macro to
# modify the way the check is run:
#