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

Merge topic 'doc-old-get_X_property-commands' 

4c980e3 Reference get_property() from old get_*_property() commands
0d7cf49 Fix get_(cmake|test)_property documentation (#11703)
This commit is contained in:
Brad King 2011-01-19 14:02:20 -05:00 committed by CMake Topic Stage
parent 27039e62f9 4c980e36bb
commit c6cb693147
5 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Source/cmGetCMakePropertyCommand.h
View File

@ -54,11 +54,14 @@ public:
{ {
return return
" get_cmake_property(VAR property)\n" " get_cmake_property(VAR property)\n"
"Get a property from the CMake instance. The value of the " "Get a property from the CMake instance. "
"property is stored in the variable VAR. If the property is " "The value of the property is stored in the variable VAR. "
"not found, CMake will report an error. Some supported properties " "If the property is not found, VAR will be set to \"NOTFOUND\". "
"Some supported properties "
"include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and " "include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and "
"COMPONENTS."; "COMPONENTS."
"\n"
"See also the more general get_property() command.";
} }
cmTypeMacro(cmGetCMakePropertyCommand, cmCommand); cmTypeMacro(cmGetCMakePropertyCommand, cmCommand);

3
Source/cmGetDirectoryPropertyCommand.h
View File

@ -66,7 +66,8 @@ public:
"Get a variable definition from a directory. " "Get a variable definition from a directory. "
"This form is useful to get a variable definition from another " "This form is useful to get a variable definition from another "
"directory." "directory."
; "\n"
"See also the more general get_property() command.";
} }
cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand); cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand);

4
Source/cmGetSourceFilePropertyCommand.h
View File

@ -53,7 +53,9 @@ public:
"stored in the variable VAR. If the property is not found, VAR " "stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". Use set_source_files_properties to set " "will be set to \"NOTFOUND\". Use set_source_files_properties to set "
"property values. Source file properties usually control how the " "property values. Source file properties usually control how the "
"file is built. One property that is always there is LOCATION"; "file is built. One property that is always there is LOCATION"
"\n"
"See also the more general get_property() command.";
} }
cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand); cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand);

4
Source/cmGetTargetPropertyCommand.h
View File

@ -55,7 +55,9 @@ public:
"property values. Properties are usually used to control how " "property values. Properties are usually used to control how "
"a target is built, but some query the target instead. " "a target is built, but some query the target instead. "
"This command can get properties for any target so far created. " "This command can get properties for any target so far created. "
"The targets do not need to be in the current CMakeLists.txt file."; "The targets do not need to be in the current CMakeLists.txt file."
"\n"
"See also the more general get_property() command.";
} }
cmTypeMacro(cmGetTargetPropertyCommand, cmCommand); cmTypeMacro(cmGetTargetPropertyCommand, cmCommand);

10
Source/cmGetTestPropertyCommand.h
View File

@ -48,11 +48,13 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" get_test_property(test VAR property)\n" " get_test_property(test property VAR)\n"
"Get a property from the Test. The value of the property is " "Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, " "stored in the variable VAR. If the property is not found, VAR "
"CMake will report an error. For a list of standard properties " "will be set to \"NOTFOUND\". For a list of standard properties "
"you can type cmake --help-property-list"; "you can type cmake --help-property-list"
"\n"
"See also the more general get_property() command.";
} }
cmTypeMacro(cmGetTestPropertyCommand, cmCommand); cmTypeMacro(cmGetTestPropertyCommand, cmCommand);