summaryrefslogtreecommitdiffstats
path: root/Source/cmGetPropertyCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2007-10-24 18:43:10 (GMT)
committerKen Martin <ken.martin@kitware.com>2007-10-24 18:43:10 (GMT)
commitf72d666a7bd7a1b58db5f08b5ee9124f6768fa2a (patch)
tree60e30ec34afc9bf475546d35689b4e18144956bd /Source/cmGetPropertyCommand.h
parentc2f0aac146f6b990940240891b959dc1f394e80c (diff)
downloadCMake-f72d666a7bd7a1b58db5f08b5ee9124f6768fa2a.zip
CMake-f72d666a7bd7a1b58db5f08b5ee9124f6768fa2a.tar.gz
CMake-f72d666a7bd7a1b58db5f08b5ee9124f6768fa2a.tar.bz2
ENH: add ability to get documentaiton of a property from a script
Diffstat (limited to 'Source/cmGetPropertyCommand.h')
-rw-r--r--Source/cmGetPropertyCommand.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/Source/cmGetPropertyCommand.h b/Source/cmGetPropertyCommand.h
index 8f2d368..f7155e1 100644
--- a/Source/cmGetPropertyCommand.h
+++ b/Source/cmGetPropertyCommand.h
@@ -58,11 +58,17 @@ public:
{
return
" get_property(VAR scope_value property)\n"
+ " get_property(VAR scope_value property \n"
+ " BRIEF_DOCS)\n"
+ " get_property(VAR scope_value property \n"
+ " FULL_DOCS)\n"
"Get a property from cmake. The scope_value is either GLOBAL, "
"DIRECTORY dir_name, TARGET tgt_name, SOURCE_FILE src_name, "
- "or TEST test_name. The resulting value is "
+ "TEST test_name or VARIABLE var_name. The resulting value is "
"stored in the variable VAR. If the property is not found, "
- "CMake will report an error.";
+ "CMake will report an error. The second and third signatures "
+ "return the documentation for a property or variable instead of "
+ "its value.";
}
cmTypeMacro(cmGetPropertyCommand, cmCommand);