summaryrefslogtreecommitdiffstats
path: root/Source/cmBuildNameCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmBuildNameCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmBuildNameCommand.h')
-rw-r--r--Source/cmBuildNameCommand.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/Source/cmBuildNameCommand.h b/Source/cmBuildNameCommand.h
index 43f812e..7f331e8 100644
--- a/Source/cmBuildNameCommand.h
+++ b/Source/cmBuildNameCommand.h
@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Depricated command. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead..";
+ return "Depricated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead.";
}
/**
@@ -67,8 +67,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "BUILD_NAME(NAME)\n"
- "Within CMAKE sets NAME to the build type.";
+ " BUILD_NAME(variable)\n"
+ "Sets the specified variable to a string representing the platform "
+ "and compiler settings. These values are now available through the "
+ "CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables.";
}
cmTypeMacro(cmBuildNameCommand, cmCommand);