summaryrefslogtreecommitdiff
path: root/Source/cmSetSourceFilesPropertiesCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2010-06-09 13:18:42 -0400
committerBrad King <brad.king@kitware.com>2010-06-09 13:18:42 -0400
commitbeabb3319e84158bdf15bf4a141726a635118835 (patch)
tree16c3626bd2b710df8b41a7740bb79c18dada9048 /Source/cmSetSourceFilesPropertiesCommand.h
parent86de1d6504737510e2107aa0323ec761d666bfaa (diff)
downloadcmake-beabb3319e84158bdf15bf4a141726a635118835.tar.gz
Document scope of source file properties
Also remove out-dated list of source file properties from the set_source_files_properties command.
Diffstat (limited to 'Source/cmSetSourceFilesPropertiesCommand.h')
-rw-r--r--Source/cmSetSourceFilesPropertiesCommand.h36
1 files changed, 8 insertions, 28 deletions
diff --git a/Source/cmSetSourceFilesPropertiesCommand.h b/Source/cmSetSourceFilesPropertiesCommand.h
index 7182152d28..392f168ce6 100644
--- a/Source/cmSetSourceFilesPropertiesCommand.h
+++ b/Source/cmSetSourceFilesPropertiesCommand.h
@@ -48,35 +48,15 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " set_source_files_properties(file1 file2 ...\n"
+ " set_source_files_properties([file1 [file2 [...]]]\n"
" PROPERTIES prop1 value1\n"
- " prop2 value2 ...)\n"
- "Set properties on a file. The syntax for the command is to list all "
- "the files you want "
- "to change, and then provide the values you want to set next. You "
- "can make up your own properties as well. "
- "The following are used by CMake. "
- "The ABSTRACT flag (boolean) is used by some class wrapping "
- "commands. "
- "If WRAP_EXCLUDE (boolean) is true then many wrapping commands "
- "will ignore this file. If GENERATED (boolean) is true then it "
- "is not an error if this source file does not exist when it is "
- "added to a target. Obviously, "
- "it must be created (presumably by a custom command) before the "
- "target is built. "
- "If the HEADER_FILE_ONLY (boolean) property is true then the "
- "file is not compiled. This is useful if you want to add extra "
- "non build files to an IDE. "
- "OBJECT_DEPENDS (string) adds dependencies to the object file. "
- "COMPILE_FLAGS (string) is passed to the compiler as additional "
- "command line arguments when the source file is compiled. "
- "LANGUAGE (string) CXX|C will change the default compiler used "
- "to compile the source file. The languages used need to be enabled "
- "in the PROJECT command. "
- "If SYMBOLIC (boolean) is set to true the build system will be "
- "informed that the source file is not actually created on disk but "
- "instead used as a symbolic name for a build rule.";
-
+ " [prop2 value2 [...]])\n"
+ "Set properties associated with source files using a key/value "
+ "paired list. "
+ "See properties documentation for those known to CMake. "
+ "Unrecognized properties are ignored. "
+ "Source file properties are visible only to targets "
+ "added in the same directory (CMakeLists.txt).";
}
cmTypeMacro(cmSetSourceFilesPropertiesCommand, cmCommand);