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 | |
| 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.
| -rw-r--r-- | Modules/CheckCCompilerFlag.cmake | 14 | ||||
| -rw-r--r-- | Modules/CheckCSourceCompiles.cmake | 10 | ||||
| -rw-r--r-- | Modules/CheckCSourceRuns.cmake | 11 | ||||
| -rw-r--r-- | Modules/CheckCXXCompilerFlag.cmake | 10 | ||||
| -rw-r--r-- | Modules/CheckCXXSourceCompiles.cmake | 10 | ||||
| -rw-r--r-- | Modules/CheckCXXSourceRuns.cmake | 11 |
6 files changed, 30 insertions, 36 deletions
diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake index 07fca64..c5c4eb1 100644 --- a/Modules/CheckCCompilerFlag.cmake +++ b/Modules/CheckCCompilerFlag.cmake @@ -1,12 +1,10 @@ # - Check whether the C compiler supports a given flag. -# CHECK_C_COMPILER_FLAG(FLAG VARIABLE) -# -# FLAG - the compiler flag -# VARIABLE - variable to store the result -# -# This actually calls the check_c_source_compiles macro. -# See help for CheckCSourceCompiles for a listing of variables -# that can modify the build. +# CHECK_C_COMPILER_FLAG(<flag> <var>) +# <flag> - the compiler flag +# <var> - variable to store the result +# This internally calls the check_c_source_compiles macro. +# See help for CheckCSourceCompiles for a listing of variables +# that can modify the build. # Copyright (c) 2006, Alexander Neundorf, <neundorf@kde.org> # diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake index 5435df4..41de73b 100644 --- a/Modules/CheckCSourceCompiles.cmake +++ b/Modules/CheckCSourceCompiles.cmake @@ -1,9 +1,7 @@ -# - Check if the C source code provided in the SOURCE argument compiles. -# CHECK_C_SOURCE_COMPILES(SOURCE VAR) -# -# SOURCE - source code to try to compile -# VAR - variable to store whether the source code compiled -# +# - Check if the given C source code compiles. +# CHECK_C_SOURCE_COMPILES(<code> <var>) +# <code> - source code to try to compile +# <var> - variable to store whether the source code compiled # The following variables may be set before calling this macro to # modify the way the check is run: # 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: # diff --git a/Modules/CheckCXXCompilerFlag.cmake b/Modules/CheckCXXCompilerFlag.cmake index 43ea9a6..cd728fa 100644 --- a/Modules/CheckCXXCompilerFlag.cmake +++ b/Modules/CheckCXXCompilerFlag.cmake @@ -1,8 +1,10 @@ # - Check whether the CXX compiler supports a given flag. -# CHECK_CXX_COMPILER_FLAG(FLAG VARIABLE) -# -# FLAG - the compiler flag -# VARIABLE - variable to store the result +# CHECK_CXX_COMPILER_FLAG(<flag> <var>) +# <flag> - the compiler flag +# <var> - variable to store the result +# This internally calls the check_cxx_source_compiles macro. See help +# for CheckCXXSourceCompiles for a listing of variables that can +# modify the build. # Copyright (c) 2006, Alexander Neundorf, <neundorf@kde.org> # diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index f987ebe..fedc53f 100644 --- a/Modules/CheckCXXSourceCompiles.cmake +++ b/Modules/CheckCXXSourceCompiles.cmake @@ -1,9 +1,7 @@ -# - Check if the C++ source code provided in the SOURCE argument compiles. -# CHECK_CXX_SOURCE_COMPILES(SOURCE VAR) -# -# SOURCE - source code to try to compile -# VAR - variable to store whether the source code compiled -# +# - Check if the given C++ source code compiles. +# CHECK_CXX_SOURCE_COMPILES(<code> <var>) +# <code> - source code to try to compile +# <var> - variable to store whether the source code compiled # The following variables may be set before calling this macro to # modify the way the check is run: # 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: # |