Merge topic 'MinorImprovementToTryCompileDocs'

d6b9df4 Minor fix to try_compile() docs (#12333)
This commit is contained in:
Brad King 2011-07-26 14:57:26 -04:00 committed by CMake Topic Stage
commit dc96b975c5
1 changed files with 5 additions and 4 deletions

View File

@ -25,7 +25,7 @@ public:
/** /**
* This is a virtual constructor for the command. * This is a virtual constructor for the command.
*/ */
virtual cmCommand* Clone() virtual cmCommand* Clone()
{ {
return new cmTryCompileCommand; return new cmTryCompileCommand;
} }
@ -45,7 +45,7 @@ public:
/** /**
* Succinct documentation. * Succinct documentation.
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Try building some code."; return "Try building some code.";
} }
@ -102,14 +102,15 @@ public:
"In both versions of the command, " "In both versions of the command, "
"if OUTPUT_VARIABLE is specified, then the " "if OUTPUT_VARIABLE is specified, then the "
"output from the build process is stored in the given variable. " "output from the build process is stored in the given variable. "
"Return the success or failure in " "The success or failure of the try_compile, i.e. TRUE or FALSE "
"respectively, is returned in "
"RESULT_VAR. CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags " "RESULT_VAR. CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags "
"to the cmake that is run during the build. " "to the cmake that is run during the build. "
"Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build " "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build "
"configuration." "configuration."
; ;
} }
cmTypeMacro(cmTryCompileCommand, cmCoreTryCompile); cmTypeMacro(cmTryCompileCommand, cmCoreTryCompile);
}; };