From 80af3ae35ddb2ff79d64d7183d901a95d05d661d Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 17 Sep 2009 15:28:51 -0400 Subject: [PATCH] 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. --- Modules/CheckCCompilerFlag.cmake | 14 ++++++-------- Modules/CheckCSourceCompiles.cmake | 10 ++++------ Modules/CheckCSourceRuns.cmake | 11 +++++------ Modules/CheckCXXCompilerFlag.cmake | 10 ++++++---- Modules/CheckCXXSourceCompiles.cmake | 10 ++++------ Modules/CheckCXXSourceRuns.cmake | 11 +++++------ 6 files changed, 30 insertions(+), 36 deletions(-) diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake index 07fca64c3..c5c4eb195 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( ) +# - the compiler flag +# - 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, # diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake index 5435df4f6..41de73b53 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( ) +# - source code to try to compile +# - 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 11d625165..3bd12e0c2 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( ) +# - source code to try to compile +# - 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 43ea9a64e..cd728fa39 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( ) +# - the compiler flag +# - 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, # diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index f987ebea4..fedc53f9f 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( ) +# - source code to try to compile +# - 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 ef9aa7168..50017c330 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( ) +# - source code to try to compile +# - 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: #