summaryrefslogtreecommitdiffstats
path: root/Source/cmSetSourceFilesPropertiesCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmSetSourceFilesPropertiesCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmSetSourceFilesPropertiesCommand.h')
-rw-r--r--Source/cmSetSourceFilesPropertiesCommand.h32
1 files changed, 23 insertions, 9 deletions
diff --git a/Source/cmSetSourceFilesPropertiesCommand.h b/Source/cmSetSourceFilesPropertiesCommand.h
index 1acbc64..6c10d68 100644
--- a/Source/cmSetSourceFilesPropertiesCommand.h
+++ b/Source/cmSetSourceFilesPropertiesCommand.h
@@ -44,7 +44,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Set attributes for a specific list of files.";
+ return "Source files can have properties that affect how they are built.";
}
/**
@@ -53,16 +53,30 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "SET_SOURCE_FILES_PROPERTIES(file1 file2 .. filen PROPERTIES prop1 value1 prop2 value2 ... prop2 valuen)"
- "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. "
+ " 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) appears to have some effect on the VTK wrapper commands. "
- "If WRAP_EXCLUDE (boolean) is true then the wrapping commands (FLTKWrapUI, QTWrapCC, QTWrapUI, VTKMakeInstantiator, VTKWrapJava, VTKWrapPython, and VTKWrapTcl) 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 dependency information is not created for that file (this is set automatically, based on the file's name's extension and is probably only used by Makefiles). "
+ "The ABSTRACT flag (boolean) appears to have some effect on the VTK "
+ "wrapper commands. "
+ "If WRAP_EXCLUDE (boolean) is true then the wrapping commands "
+ "(FLTKWrapUI, QTWrapCC, QTWrapUI, VTKMakeInstantiator, VTKWrapJava, "
+ "VTKWrapPython, and VTKWrapTcl) 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 dependency "
+ "information is not created for that file (this is set "
+ "automatically, based on the file's name's extension and is probably "
+ "only used by Makefiles). "
"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. ";
+ "COMPILE_FLAGS (string) is passed to the compiler as additional "
+ "command line arguments when the source file is compiled. ";
}