diff options
| author | Brad King <brad.king@kitware.com> | 2009-09-17 19:28:51 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2009-09-17 19:28:51 (GMT) |
| commit | 80af3ae35ddb2ff79d64d7183d901a95d05d661d (patch) | |
| tree | 05b229db83f5f3caf7c792a06a680cf9478bc5c2 /Modules/CheckCXXSourceRuns.cmake | |
| parent | 308e972412cdf3d8cde77b07527465e75888301a (diff) | |
| download | CMake-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/CheckCXXSourceRuns.cmake')
| -rw-r--r-- | Modules/CheckCXXSourceRuns.cmake | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/Modules/CheckCXXSourceRuns.cmake b/Modules/CheckCXXSourceRuns.cmake index ef9aa71..50017c3 100644 --- a/Modules/CheckCXXSourceRuns.cmake +++ b/Modules/CheckCXXSourceRuns.cmake @@ -1,9 +1,8 @@ -# - Check if the C++ source code provided in the SOURCE argument compiles and runs. -# CHECK_CXX_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_CXX_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: # |