From 80af3ae35ddb2ff79d64d7183d901a95d05d661d Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 17 Sep 2009 15:28:51 -0400 Subject: 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/CheckCXXCompilerFlag.cmake | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'Modules/CheckCXXCompilerFlag.cmake') diff --git a/Modules/CheckCXXCompilerFlag.cmake b/Modules/CheckCXXCompilerFlag.cmake index 43ea9a64e5..cd728fa395 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, # -- cgit v1.2.1