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

Merge topic 'doc-enable_language-scope' 

b3b57e7 enable_language: Clarify documentation
This commit is contained in:
Brad King 2013-06-14 09:01:39 -04:00 committed by CMake Topic Stage
parent d556631079 b3b57e7a31
commit dea8271840
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Source/cmEnableLanguageCommand.h
View File

@ -59,18 +59,21 @@ public:
virtual const char* GetFullDocumentation() const virtual const char* GetFullDocumentation() const
{ {
return return
" enable_language(languageName [OPTIONAL] )\n" " enable_language(<lang> [OPTIONAL] )\n"
"This command enables support for the named language in CMake. " "This command enables support for the named language in CMake. "
"This is the same as the project command but does not create " "This is the same as the project command but does not create "
"any of the extra variables that are created by the project command. " "any of the extra variables that are created by the project command. "
"Example languages are CXX, C, Fortran. " "Example languages are CXX, C, Fortran. "
"If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS "
"variable to check whether the language has been enabled successfully."
"\n" "\n"
"This command must be called on file scope (not inside a function) and " "This command must be called in file scope, not in a function call. "
"the language enabled can only be used in the calling project or its " "Furthermore, it must be called in the highest directory common to "
"subdirectories added by add_subdirectory(). Also note that at present, " "all targets using the named language directly for compiling sources "
"the OPTIONAL argument does not work."; "or indirectly through link dependencies. "
"It is simplest to enable all needed languages in the top-level "
"directory of a project."
"\n"
"The OPTIONAL keyword is a placeholder for future implementation "
"and does not currently work.";
} }
cmTypeMacro(cmEnableLanguageCommand, cmCommand); cmTypeMacro(cmEnableLanguageCommand, cmCommand);