summaryrefslogtreecommitdiffstats
path: root/Source/cmProjectCommand.h
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2009-03-12 22:43:17 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2009-03-12 22:43:17 (GMT)
commit5174fbd39079e6cb3b43599e6ee234d9e550201a (patch)
tree9dc8212e1f53231d0bf15095a79ed334994f177b /Source/cmProjectCommand.h
parent0a65ee8d95f20b1d4a499fc044ddf97a0c28c9b8 (diff)
downloadCMake-5174fbd39079e6cb3b43599e6ee234d9e550201a.zip
CMake-5174fbd39079e6cb3b43599e6ee234d9e550201a.tar.gz
CMake-5174fbd39079e6cb3b43599e6ee234d9e550201a.tar.bz2
STYLE: document NONE for disabling any languages, slightly change wording of
the rest of the documentation, so it is more similar to ENABLE_LANGUAGE() (#8718) Alex
Diffstat (limited to 'Source/cmProjectCommand.h')
-rw-r--r--Source/cmProjectCommand.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h
index 4e9b289..fe3b36c 100644
--- a/Source/cmProjectCommand.h
+++ b/Source/cmProjectCommand.h
@@ -64,14 +64,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " project(projectname [CXX] [C] [Java])\n"
+ " project(<projectname> [languageName1 languageName2 ... ] )\n"
"Sets the name of the project. "
- "This creates the variables projectname_BINARY_DIR and "
- "projectname_SOURCE_DIR. "
+ "Additionally this sets the variables <projectName>_BINARY_DIR and "
+ "<projectName>_SOURCE_DIR to the respective values.\n"
"Optionally you can specify which languages your project supports. "
- "By default all languages are supported. If you do not have a "
- "C++ compiler, but want"
- " to build a c program with cmake, then use this option.";
+ "Example languages are CXX (i.e. C++), C, Fortran, etc. "
+ "By default C and CXX are enabled. E.g. if you do not have a "
+ "C++ compiler, you can disable the check for it by explicitely listing "
+ "the languages you want to support, e.g. C. By using the special "
+ "language \"NONE\" all checks for any language can be disabled.";
}
cmTypeMacro(cmProjectCommand, cmCommand);