summaryrefslogtreecommitdiffstats
path: root/Source/cmGetCMakePropertyCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-01-17 14:14:35 (GMT)
committerBrad King <brad.king@kitware.com>2011-01-17 14:14:35 (GMT)
commit0d7cf4951a5f3e375096ba4426a6cb503266f9df (patch)
tree7a7d18b635a3f31a128222f43babfa7b9b1a3619 /Source/cmGetCMakePropertyCommand.h
parent6b084f1e0469a84eebfa6c849ac2a4445a9e2438 (diff)
downloadCMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.zip
CMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.tar.gz
CMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.tar.bz2
Fix get_(cmake|test)_property documentation (#11703)
The signature of get_test_property uses argument order test property VAR not test VAR property Also document the actual behavior when the property is not found.
Diffstat (limited to 'Source/cmGetCMakePropertyCommand.h')
-rw-r--r--Source/cmGetCMakePropertyCommand.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/Source/cmGetCMakePropertyCommand.h b/Source/cmGetCMakePropertyCommand.h
index c78671e..acbbfee 100644
--- a/Source/cmGetCMakePropertyCommand.h
+++ b/Source/cmGetCMakePropertyCommand.h
@@ -54,9 +54,10 @@ public:
{
return
" get_cmake_property(VAR property)\n"
- "Get a property from the CMake instance. The value of the "
- "property is stored in the variable VAR. If the property is "
- "not found, CMake will report an error. Some supported properties "
+ "Get a property from the CMake instance. "
+ "The value of the property is stored in the variable VAR. "
+ "If the property is not found, VAR will be set to \"NOTFOUND\". "
+ "Some supported properties "
"include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and "
"COMPONENTS.";
}