kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

STYLE: rename chain to inherit in the docs 

Alex
This commit is contained in:
Alexander Neundorf 2007-06-26 13:50:14 -04:00
parent cd8687782b
commit 2504ffe8c3
3 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Source/cmDefinePropertyCommand.h
View File

@ -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."
;
}

2
Source/cmGetPropertyCommand.h
View File

@ -58,7 +58,7 @@ public:
{
return
" GET_PROPERTY(VAR scope_value property)\n"
"Get a property from cmake. The scope_value is either GLOBAL "
"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 "
"stored in the variable VAR. If the property is not found, "

2
Source/cmSetPropertiesCommand.h
View File

@ -55,7 +55,7 @@ public:
" SET_PROPERTIES(scope_value\n"
" PROPERTIES prop1 value1\n"
" prop2 value2 ...)\n"
"Set properties on something. The scope_value is either GLOBAL "
"Set properties on something. The scope_value is either GLOBAL, "
"DIRECTORY dir_name, TARGET tgt_name, SOURCE_FILE src_name, "
"or TEST test_name."
;