summaryrefslogtreecommitdiffstats
path: root/Source/cmGetSourceFilePropertyCommand.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/cmGetSourceFilePropertyCommand.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/cmGetSourceFilePropertyCommand.h')
-rw-r--r--Source/cmGetSourceFilePropertyCommand.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/Source/cmGetSourceFilePropertyCommand.h b/Source/cmGetSourceFilePropertyCommand.h
index 0fd158c..b16bc60 100644
--- a/Source/cmGetSourceFilePropertyCommand.h
+++ b/Source/cmGetSourceFilePropertyCommand.h
@@ -44,7 +44,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Get a property for a file";
+ return "Get a property for a source file.";
}
/**
@@ -53,10 +53,12 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "GET_SOURCE_FILE_PROPERTY(VAR file property) "
- "Get a property from a source file. The value of the property is "
- " stored in the variable VAR. If the property is not found, var "
- "will be set to NOT_FOUND";
+ " GET_SOURCE_FILE_PROPERTY(VAR file property)\n"
+ "Get a property from a source file. The value of the property is "
+ "stored in the variable VAR. If the property is not found, var "
+ "will be set to NOT_FOUND. Use SET_SOURCE_FILES_PROPERTIES to set "
+ "property values. Source file properties usually control how the "
+ "file is built.";
}
cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand);