summaryrefslogtreecommitdiffstats
path: root/Source/cmDefinePropertyCommand.h
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2007-06-26 17:50:14 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2007-06-26 17:50:14 (GMT)
commit2504ffe8c370fb0c89bfe002226b28a7cb2244c6 (patch)
tree2a81a398523c6ecafcb0013963d9625f9a678820 /Source/cmDefinePropertyCommand.h
parentcd8687782b8ff4ee991daa677d04f885bb37d274 (diff)
downloadCMake-2504ffe8c370fb0c89bfe002226b28a7cb2244c6.zip
CMake-2504ffe8c370fb0c89bfe002226b28a7cb2244c6.tar.gz
CMake-2504ffe8c370fb0c89bfe002226b28a7cb2244c6.tar.bz2
STYLE: rename chain to inherit in the docs
Alex
Diffstat (limited to 'Source/cmDefinePropertyCommand.h')
-rw-r--r--Source/cmDefinePropertyCommand.h19
1 files changed, 9 insertions, 10 deletions
diff --git a/Source/cmDefinePropertyCommand.h b/Source/cmDefinePropertyCommand.h
index 95aa0ab..0cc1f31 100644
--- a/Source/cmDefinePropertyCommand.h
+++ b/Source/cmDefinePropertyCommand.h
@@ -54,16 +54,15 @@ public:
return
" DEFINE_PROPERTY(property_name scope_value\n"
" short_description\n"
- " full_description chain)\n"
- "Define a property for a scope. The scope_value is either GLOBAL "
- "DIRECTORY, TARGET, TEST, SOURCE_FILE, VARIABLE, CACHED_VARIABLE. "
- "The short and full "
- "descriptions are used to document the property, chain indicates "
- "if that property chains such that a request for the property "
- "on a target will chain up to the directory if it is not set on the "
- "target. In such cases the property's scope is the most specific. "
- "In that example the scope would be TARGET even though it can "
- "chain up to DIRECTORY and GLOBAL."
+ " full_description inherit)\n"
+ "Define a property for a scope. scope_value is either GLOBAL, "
+ "DIRECTORY, TARGET, TEST, SOURCE_FILE, VARIABLE or CACHED_VARIABLE. "
+ "The short and full descriptions are used to document the property. "
+ "If inherit is TRUE, it will inherit its value from the next more "
+ "global property if it hasn't been set at the specified scope. "
+ "This means that e.g. a TARGET property inherits it's value from the "
+ "DIRECTORY property with the same name if it hasn't been set for the "
+ "target, and then from GLOBAL if it hasn't been set for the directory."
;
}