mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-21 22:50:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

ENH: Cleaned up documentation and formatted it for use by cmDocumentation.

Browse Source
This commit is contained in:
Brad King
2003-02-14 18:47:16 -05:00
parent dec0b51066
commit a02574158d
75 changed files with 612 additions and 365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Source/cmConfigureFileCommand.h
View File

@@ -44,7 +44,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
return "Create a file from an autoconf style file.in file.";
return "Copy a file to another location and modify its contents.";
}
/**
@@ -53,19 +53,21 @@ public:
virtual const char* GetFullDocumentation()
{
return
"CONFIGURE_FILE(InputFile OutputFile [COPYONLY] [ESCAPE_QUOTES] [IMMEDIATE] [@ONLY])\n"
"The Input and Ouput files have to have full paths.\n"
"They can also use variables like CMAKE_BINARY_DIR,CMAKE_SOURCE_DIR. "
"This command replaces any variables in the input file with their "
"values as determined by CMake. If a variables in not defined, it "
"will be replaced with nothing. If COPYONLY is passed in, then "
"then no variable expansion will take place. If ESCAPE_QUOTES is "
"passed in then any substitued quotes will be C style escaped. "
" CONFIGURE_FILE(InputFile OutputFile\n"
" [COPYONLY] [ESCAPE_QUOTES]\n"
" [IMMEDIATE] [@ONLY])\n"
"The Input and Ouput files have to have full paths. "
"This command replaces any variables in the input file referenced as "
"${VAR} or @VAR@ with their values as determined by CMake. If a "
"variable is not defined, it will be replaced with nothing. "
"If COPYONLY is specified, then then no variable expansion will take "
"place. If ESCAPE_QUOTES is specified in then any substitued quotes "
"will be C-style escaped. "
"If IMMEDIATE is specified, then the file will be configured with "
"the current values of CMake variables instead of waiting until the "
"end of CMakeLists processing. If @ONLY is present, only variables "
"of the form @var@ will be replaces and ${var} will be ignored. "
"This is useful for configuring tcl scripts that use ${var}.";
"end of CMakeLists processing. If @ONLY is specified, only variables "
"of the form @VAR@ will be replaces and ${VAR} will be ignored. "
"This is useful for configuring tcl scripts that use ${VAR}.";
}
virtual void FinalPass();