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/CheckCXXCompilerFlag.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/CheckCXXCompilerFlag.cmake')
| -rw-r--r-- | Modules/CheckCXXCompilerFlag.cmake | 10 |
1 files changed, 6 insertions, 4 deletions
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> # |